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 java.lang.Object
implements SlackApiRequest
Provide custom unfurl behavior for user-posted URLs

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ChatUnfurlRequest.ChatUnfurlRequestBuilder  
    static class  ChatUnfurlRequest.UnfurlDetail  

  • Method Summary

    Modifier and Type Method Description
    static ChatUnfurlRequest.ChatUnfurlRequestBuilder builder()  
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.String getChannel()
    Channel ID of the message
    java.lang.String getRawUnfurls()
    URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.
    java.lang.String getSource()  
    java.lang.String getToken()
    Authentication token.
    java.lang.String getTs()
    Timestamp of the message to add unfurl behavior to.
    java.lang.String getUnfurlId()  
    java.util.Map<java.lang.String,​ChatUnfurlRequest.UnfurlDetail> getUnfurls()  
    java.util.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
    java.lang.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
    java.lang.String getUserAuthUrl()
    Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling.
    int hashCode()  
    boolean isUserAuthRequired()
    Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain
    void setChannel​(java.lang.String channel)
    Channel ID of the message
    void setRawUnfurls​(java.lang.String rawUnfurls)
    URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.
    void setSource​(java.lang.String source)  
    void setToken​(java.lang.String token)
    Authentication token.
    void setTs​(java.lang.String ts)
    Timestamp of the message to add unfurl behavior to.
    void setUnfurlId​(java.lang.String unfurlId)  
    void setUnfurls​(java.util.Map<java.lang.String,​ChatUnfurlRequest.UnfurlDetail> unfurls)  
    void setUserAuthBlocks​(java.util.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
    void setUserAuthMessage​(java.lang.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
    void setUserAuthRequired​(boolean userAuthRequired)
    Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain
    void setUserAuthUrl​(java.lang.String userAuthUrl)
    Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      public static ChatUnfurlRequest.ChatUnfurlRequestBuilder builder()

    • getToken

      public java.lang.String getToken()
      Authentication token. Requires scope: `links:write`
      Specified by:
      getToken in interface SlackApiRequest

    • getUserAuthMessage

      public java.lang.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

    • getUserAuthBlocks

      public java.util.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

    • getRawUnfurls

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

    • getUnfurls

      public java.util.Map<java.lang.String,​ChatUnfurlRequest.UnfurlDetail> getUnfurls()

    • getTs

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

    • getUserAuthUrl

      public java.lang.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.

    • getChannel

      public java.lang.String getChannel()
      Channel ID of the message

    • getUnfurlId

      public java.lang.String getUnfurlId()

    • getSource

      public java.lang.String getSource()

    • setToken

      public void setToken​(java.lang.String token)
      Authentication token. Requires scope: `links:write`

    • setUserAuthMessage

      public void setUserAuthMessage​(java.lang.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

    • setUserAuthBlocks

      public void setUserAuthBlocks​(java.util.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

    • setRawUnfurls

      public void setRawUnfurls​(java.lang.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​(java.util.Map<java.lang.String,​ChatUnfurlRequest.UnfurlDetail> unfurls)

    • setTs

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

    • setUserAuthUrl

      public void setUserAuthUrl​(java.lang.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.

    • setChannel

      public void setChannel​(java.lang.String channel)
      Channel ID of the message

    • setUnfurlId

      public void setUnfurlId​(java.lang.String unfurlId)

    • setSource

      public void setSource​(java.lang.String source)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object