Class ChatUnfurlRequest
- java.lang.Object
-
- com.slack.api.methods.request.chat.ChatUnfurlRequest
-
- All Implemented Interfaces:
SlackApiRequest
public class ChatUnfurlRequest extends Object implements SlackApiRequest
Provide custom unfurl behavior for user-posted URLs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classChatUnfurlRequest.ChatUnfurlRequestBuilderstatic classChatUnfurlRequest.UnfurlDetail
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ChatUnfurlRequest.ChatUnfurlRequestBuilderbuilder()protected booleancanEqual(Object other)booleanequals(Object o)StringgetChannel()Channel ID of the messageStringgetRawUnfurls()URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.StringgetToken()Authentication token.StringgetTs()Timestamp of the message to add unfurl behavior to.Map<String,ChatUnfurlRequest.UnfurlDetail>getUnfurls()StringgetUserAuthMessage()Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behaviorStringgetUserAuthUrl()Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling.inthashCode()booleanisUserAuthRequired()Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domainvoidsetChannel(String channel)Channel ID of the messagevoidsetRawUnfurls(String rawUnfurls)URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.voidsetToken(String token)Authentication token.voidsetTs(String ts)Timestamp of the message to add unfurl behavior to.voidsetUnfurls(Map<String,ChatUnfurlRequest.UnfurlDetail> unfurls)voidsetUserAuthMessage(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 behaviorvoidsetUserAuthRequired(boolean userAuthRequired)Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domainvoidsetUserAuthUrl(String userAuthUrl)Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling.StringtoString()
-
-
-
Method Detail
-
builder
public static ChatUnfurlRequest.ChatUnfurlRequestBuilder builder()
-
getToken
public String getToken()
Authentication token. Requires scope: `links:write`- Specified by:
getTokenin interfaceSlackApiRequest
-
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
-
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 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.
-
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.
-
getChannel
public String getChannel()
Channel ID of the message
-
setToken
public void setToken(String token)
Authentication token. Requires scope: `links:write`
-
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
-
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(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.
-
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.
-
setChannel
public void setChannel(String channel)
Channel ID of the message
-
canEqual
protected boolean canEqual(Object other)
-
-