Package com.slack.api.bolt.context
Class Context
- java.lang.Object
-
- com.slack.api.bolt.context.Context
-
- Direct Known Subclasses:
ActionContext
,AttachmentActionContext
,BlockSuggestionContext
,DefaultContext
,DialogCancellationContext
,DialogSubmissionContext
,DialogSuggestionContext
,EventContext
,GlobalShortcutContext
,MessageShortcutContext
,OAuthCallbackContext
,SlashCommandContext
,ViewSubmissionContext
,WorkflowStepEditContext
,WorkflowStepExecuteContext
,WorkflowStepSaveContext
public abstract class Context extends Object
Represents a context behind a request from Slack API.
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,String>
additionalValues
protected AuthTestResponse
authTestResponse
The `auth.test` response received in authorization middlewareprotected String
botId
bot_id associated with this request.protected List<String>
botScopes
The scopes associated to the botTokenprotected String
botToken
A bot token associated with this request.protected String
botUserId
Bot user's user_id associated with this request.protected String
enterpriseId
Organization ID for Enterprise Grid.protected boolean
enterpriseInstall
Returns true if the token is issued by an enterprise install (= org-level installation)org.slf4j.Logger
logger
protected String
requestUserId
The user's ID associated with this request.protected List<String>
requestUserScopes
The scopes associated to the requestUserTokenprotected String
requestUserToken
The user token that is associated with the request user ID.protected Slack
slack
protected String
teamId
Workspace ID.
-
Constructor Summary
Constructors Constructor Description Context()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Response
ack()
Response
ack(com.google.gson.JsonElement json)
Response
ackWithJson(Object obj)
AsyncMethodsClient
asyncClient()
MethodsClient
client()
Map<String,String>
getAdditionalValues()
AuthTestResponse
getAuthTestResponse()
The `auth.test` response received in authorization middlewareString
getBotId()
bot_id associated with this request.List<String>
getBotScopes()
The scopes associated to the botTokenString
getBotToken()
A bot token associated with this request.String
getBotUserId()
Bot user's user_id associated with this request.String
getEnterpriseId()
Organization ID for Enterprise Grid.org.slf4j.Logger
getLogger()
String
getRequestUserId()
The user's ID associated with this request.List<String>
getRequestUserScopes()
The scopes associated to the requestUserTokenString
getRequestUserToken()
The user token that is associated with the request user ID.Slack
getSlack()
String
getTeamId()
Workspace ID.boolean
isEnterpriseInstall()
Returns true if the token is issued by an enterprise install (= org-level installation)ChatPostMessageResponse
say(BuilderConfigurator<ChatPostMessageRequest.ChatPostMessageRequestBuilder> request)
void
setAuthTestResponse(AuthTestResponse authTestResponse)
The `auth.test` response received in authorization middlewarevoid
setBotId(String botId)
bot_id associated with this request.void
setBotScopes(List<String> botScopes)
The scopes associated to the botTokenvoid
setBotToken(String botToken)
A bot token associated with this request.void
setBotUserId(String botUserId)
Bot user's user_id associated with this request.void
setEnterpriseId(String enterpriseId)
Organization ID for Enterprise Grid.void
setEnterpriseInstall(boolean enterpriseInstall)
Returns true if the token is issued by an enterprise install (= org-level installation)void
setRequestUserId(String requestUserId)
The user's ID associated with this request.void
setRequestUserScopes(List<String> requestUserScopes)
The scopes associated to the requestUserTokenvoid
setRequestUserToken(String requestUserToken)
The user token that is associated with the request user ID.void
setSlack(Slack slack)
void
setTeamId(String teamId)
Workspace ID.com.google.gson.JsonElement
toJson(Object obj)
String
toString()
-
-
-
Field Detail
-
slack
protected Slack slack
-
logger
public final org.slf4j.Logger logger
-
enterpriseId
protected String enterpriseId
Organization ID for Enterprise Grid.
-
teamId
protected String teamId
Workspace ID.
-
enterpriseInstall
protected boolean enterpriseInstall
Returns true if the token is issued by an enterprise install (= org-level installation)
-
botToken
protected String botToken
A bot token associated with this request. The format must be starting with `xoxb-`.
-
botId
protected String botId
bot_id associated with this request.
-
botUserId
protected String botUserId
Bot user's user_id associated with this request.
-
requestUserId
protected String requestUserId
The user's ID associated with this request.
-
requestUserToken
protected String requestUserToken
The user token that is associated with the request user ID.
-
requestUserScopes
protected List<String> requestUserScopes
The scopes associated to the requestUserToken
-
authTestResponse
protected AuthTestResponse authTestResponse
The `auth.test` response received in authorization middleware
-
-
Method Detail
-
client
public MethodsClient client()
-
asyncClient
public AsyncMethodsClient asyncClient()
-
say
public ChatPostMessageResponse say(BuilderConfigurator<ChatPostMessageRequest.ChatPostMessageRequestBuilder> request) throws IOException, SlackApiException
- Throws:
IOException
SlackApiException
-
ack
public Response ack()
-
ack
public Response ack(com.google.gson.JsonElement json)
-
toJson
public com.google.gson.JsonElement toJson(Object obj)
-
getSlack
public Slack getSlack()
-
getLogger
public org.slf4j.Logger getLogger()
-
getEnterpriseId
public String getEnterpriseId()
Organization ID for Enterprise Grid.
-
getTeamId
public String getTeamId()
Workspace ID.
-
isEnterpriseInstall
public boolean isEnterpriseInstall()
Returns true if the token is issued by an enterprise install (= org-level installation)
-
getBotToken
public String getBotToken()
A bot token associated with this request. The format must be starting with `xoxb-`.
-
getBotId
public String getBotId()
bot_id associated with this request.
-
getBotUserId
public String getBotUserId()
Bot user's user_id associated with this request.
-
getRequestUserId
public String getRequestUserId()
The user's ID associated with this request.
-
getRequestUserToken
public String getRequestUserToken()
The user token that is associated with the request user ID.
-
getRequestUserScopes
public List<String> getRequestUserScopes()
The scopes associated to the requestUserToken
-
getAuthTestResponse
public AuthTestResponse getAuthTestResponse()
The `auth.test` response received in authorization middleware
-
setSlack
public void setSlack(Slack slack)
-
setEnterpriseId
public void setEnterpriseId(String enterpriseId)
Organization ID for Enterprise Grid.
-
setTeamId
public void setTeamId(String teamId)
Workspace ID.
-
setEnterpriseInstall
public void setEnterpriseInstall(boolean enterpriseInstall)
Returns true if the token is issued by an enterprise install (= org-level installation)
-
setBotToken
public void setBotToken(String botToken)
A bot token associated with this request. The format must be starting with `xoxb-`.
-
setBotScopes
public void setBotScopes(List<String> botScopes)
The scopes associated to the botToken
-
setBotId
public void setBotId(String botId)
bot_id associated with this request.
-
setBotUserId
public void setBotUserId(String botUserId)
Bot user's user_id associated with this request.
-
setRequestUserId
public void setRequestUserId(String requestUserId)
The user's ID associated with this request.
-
setRequestUserToken
public void setRequestUserToken(String requestUserToken)
The user token that is associated with the request user ID.
-
setRequestUserScopes
public void setRequestUserScopes(List<String> requestUserScopes)
The scopes associated to the requestUserToken
-
setAuthTestResponse
public void setAuthTestResponse(AuthTestResponse authTestResponse)
The `auth.test` response received in authorization middleware
-
-