Class ChatUnfurlRequest
- java.lang.Object
-
- com.slack.api.methods.request.chat.ChatUnfurlRequest
-
- All Implemented Interfaces:
SlackApiRequest
public class ChatUnfurlRequest extends Object implements SlackApiRequest
https://api.slack.com/methods/chat.unfurl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChatUnfurlRequest.ChatUnfurlRequestBuilder
static class
ChatUnfurlRequest.UnfurlDetail
static class
ChatUnfurlRequest.UnfurlDetailPreview
-
Constructor Summary
Constructors Constructor Description ChatUnfurlRequest()
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)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ChatUnfurlRequest.ChatUnfurlRequestBuilder
builder()
protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getChannel()
Channel ID of the messageString
getRawUnfurls()
URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.String
getRawUserAuthBlocks()
String
getSource()
String
getToken()
Authentication token.String
getTs()
Timestamp of the message to add unfurl behavior to.String
getUnfurlId()
Map<String,ChatUnfurlRequest.UnfurlDetail>
getUnfurls()
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 behaviorString
getUserAuthMessage()
Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behaviorString
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 domainvoid
setChannel(String channel)
Channel ID of the messagevoid
setRawUnfurls(String rawUnfurls)
URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl message attachments.void
setRawUserAuthBlocks(String rawUserAuthBlocks)
void
setSource(String source)
void
setToken(String token)
Authentication token.void
setTs(String ts)
Timestamp of the message to add unfurl behavior to.void
setUnfurlId(String unfurlId)
void
setUnfurls(Map<String,ChatUnfurlRequest.UnfurlDetail> unfurls)
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 behaviorvoid
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 behaviorvoid
setUserAuthRequired(boolean userAuthRequired)
Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domainvoid
setUserAuthUrl(String userAuthUrl)
Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling.String
toString()
-
-
-
Constructor Detail
-
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)
-
-
Method Detail
-
builder
public static ChatUnfurlRequest.ChatUnfurlRequestBuilder builder()
-
getToken
public String getToken()
Authentication token. Requires scope: `links:write`- Specified by:
getToken
in interfaceSlackApiRequest
- 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()
-
setToken
public void setToken(String token)
Authentication token. Requires scope: `links:write`- Specified by:
setToken
in interfaceSlackApiRequest
-
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)
-
canEqual
protected boolean canEqual(Object other)
-
-