Package com.slack.api.methods.request.chat

Class ChatUnfurlRequest

java.lang.Object
com.slack.api.methods.request.chat.ChatUnfurlRequest
All Implemented Interfaces:
SlackApiRequest
public class ChatUnfurlRequest extends Object implements SlackApiRequest
https://docs.slack.dev/reference/methods/chat.unfurl

  • Constructor Details

    • ChatUnfurlRequest

      public ChatUnfurlRequest()

    • ChatUnfurlRequest

      public ChatUnfurlRequest(String token, String userAuthMessage, String rawUserAuthBlocks, List<LayoutBlock> userAuthBlocks, boolean userAuthRequired, String userAuthUrl, String rawUnfurls, Map<String,ChatUnfurlRequest.UnfurlDetail> unfurls, String ts, String channel, String unfurlId, String source, String rawMetadata, ChatUnfurlRequest.UnfurlMetadata metadata)
      Creates a new ChatUnfurlRequest instance.
      Parameters:
      token - Authentication token. Requires scope: `links:write`
      userAuthMessage - Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
      rawUserAuthBlocks -
      userAuthBlocks - Provide an array of blocks to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
      userAuthRequired - Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain
      userAuthUrl - Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
      rawUnfurls - URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.
      unfurls -
      ts - Timestamp of the message to add unfurl behavior to.
      channel - Channel ID of the message
      unfurlId -
      source -
      rawMetadata - JSON object with an entities field providing an array of work object entities.
      metadata -

  • Method Details

    • builder

      public static ChatUnfurlRequest.ChatUnfurlRequestBuilder builder()

    • getToken

      public String getToken()
      Authentication token. Requires scope: `links:write`
      Specified by:
      getToken in interface SlackApiRequest
      Returns:
      token string value or null

    • getUserAuthMessage

      public String getUserAuthMessage()
      Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

    • getRawUserAuthBlocks

      public String getRawUserAuthBlocks()

    • getUserAuthBlocks

      public List<LayoutBlock> getUserAuthBlocks()
      Provide an array of blocks to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

    • isUserAuthRequired

      public boolean isUserAuthRequired()
      Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain

    • getUserAuthUrl

      public String getUserAuthUrl()
      Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

    • getRawUnfurls

      public String getRawUnfurls()
      URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.

    • getUnfurls

      public Map<String,ChatUnfurlRequest.UnfurlDetail> getUnfurls()

    • getTs

      public String getTs()
      Timestamp of the message to add unfurl behavior to.

    • getChannel

      public String getChannel()
      Channel ID of the message

    • getUnfurlId

      public String getUnfurlId()

    • getSource

      public String getSource()

    • getRawMetadata

      public String getRawMetadata()
      JSON object with an entities field providing an array of work object entities.

    • getMetadata

      public ChatUnfurlRequest.UnfurlMetadata getMetadata()

    • setToken

      public void setToken(String token)
      Authentication token. Requires scope: `links:write`
      Specified by:
      setToken in interface SlackApiRequest

    • setUserAuthMessage

      public void setUserAuthMessage(String userAuthMessage)
      Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

    • setRawUserAuthBlocks

      public void setRawUserAuthBlocks(String rawUserAuthBlocks)

    • setUserAuthBlocks

      public void setUserAuthBlocks(List<LayoutBlock> userAuthBlocks)
      Provide an array of blocks to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

    • setUserAuthRequired

      public void setUserAuthRequired(boolean userAuthRequired)
      Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain

    • setUserAuthUrl

      public void setUserAuthUrl(String userAuthUrl)
      Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

    • setRawUnfurls

      public void setRawUnfurls(String rawUnfurls)
      URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.

    • setUnfurls

      public void setUnfurls(Map<String,ChatUnfurlRequest.UnfurlDetail> unfurls)

    • setTs

      public void setTs(String ts)
      Timestamp of the message to add unfurl behavior to.

    • setChannel

      public void setChannel(String channel)
      Channel ID of the message

    • setUnfurlId

      public void setUnfurlId(String unfurlId)

    • setSource

      public void setSource(String source)

    • setRawMetadata

      public void setRawMetadata(String rawMetadata)
      JSON object with an entities field providing an array of work object entities.

    • setMetadata

      public void setMetadata(ChatUnfurlRequest.UnfurlMetadata metadata)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object