Package com.slack.api.methods

Interface SlackApiRequest

All Known Implementing Classes:

AdminAnalyticsGetFileRequest, AdminAppsActivitiesListRequest, AdminAppsApprovedListRequest, AdminAppsApproveRequest, AdminAppsClearResolutionRequest, AdminAppsConfigLookupRequest, AdminAppsConfigSetRequest, AdminAppsRequestsCancelRequest, AdminAppsRequestsListRequest, AdminAppsRestrictedListRequest, AdminAppsRestrictRequest, AdminAppsUninstallRequest, AdminAuthPolicyAssignEntitiesRequest, AdminAuthPolicyGetEntitiesRequest, AdminAuthPolicyRemoveEntitiesRequest, AdminBarriersCreateRequest, AdminBarriersDeleteRequest, AdminBarriersListRequest, AdminBarriersUpdateRequest, AdminConversationsArchiveRequest, AdminConversationsBulkArchiveRequest, AdminConversationsBulkDeleteRequest, AdminConversationsBulkMoveRequest, AdminConversationsConvertToPrivateRequest, AdminConversationsConvertToPublicRequest, AdminConversationsCreateRequest, AdminConversationsDeleteRequest, AdminConversationsDisconnectSharedRequest, AdminConversationsEkmListOriginalConnectedChannelInfoRequest, AdminConversationsGetConversationPrefsRequest, AdminConversationsGetCustomRetentionRequest, AdminConversationsGetTeamsRequest, AdminConversationsInviteRequest, AdminConversationsLookupRequest, AdminConversationsRemoveCustomRetentionRequest, AdminConversationsRenameRequest, AdminConversationsRestrictAccessAddGroupRequest, AdminConversationsRestrictAccessListGroupsRequest, AdminConversationsRestrictAccessRemoveGroupRequest, AdminConversationsSearchRequest, AdminConversationsSetConversationPrefsRequest, AdminConversationsSetCustomRetentionRequest, AdminConversationsSetTeamsRequest, AdminConversationsUnarchiveRequest, AdminConversationsWhitelistAddRequest, AdminConversationsWhitelistListGroupsLinkedToChannelRequest, AdminConversationsWhitelistRemoveRequest, AdminEmojiAddAliasRequest, AdminEmojiAddRequest, AdminEmojiListRequest, AdminEmojiRemoveRequest, AdminEmojiRenameRequest, AdminFunctionsListRequest, AdminFunctionsPermissionsLookupRequest, AdminFunctionsPermissionsSetRequest, AdminInviteRequestsApprovedListRequest, AdminInviteRequestsApproveRequest, AdminInviteRequestsDeniedListRequest, AdminInviteRequestsDenyRequest, AdminInviteRequestsListRequest, AdminRolesAddAssignmentsRequest, AdminRolesListAssignmentsRequest, AdminRolesRemoveAssignmentsRequest, AdminTeamsAdminsListRequest, AdminTeamsCreateRequest, AdminTeamsListRequest, AdminTeamsOwnersListRequest, AdminTeamsSettingsInfoRequest, AdminTeamsSettingsSetDefaultChannelsRequest, AdminTeamsSettingsSetDescriptionRequest, AdminTeamsSettingsSetDiscoverabilityRequest, AdminTeamsSettingsSetIconRequest, AdminTeamsSettingsSetNameRequest, AdminUsergroupsAddChannelsRequest, AdminUsergroupsAddTeamsRequest, AdminUsergroupsListChannelsRequest, AdminUsergroupsRemoveChannelsRequest, AdminUsersAssignRequest, AdminUsersInviteRequest, AdminUsersListRequest, AdminUsersRemoveRequest, AdminUsersSessionClearSettingsRequest, AdminUsersSessionGetSettingsRequest, AdminUsersSessionInvalidateRequest, AdminUsersSessionListRequest, AdminUsersSessionResetBulkRequest, AdminUsersSessionResetRequest, AdminUsersSessionSetSettingsRequest, AdminUsersSetAdminRequest, AdminUsersSetExpirationRequest, AdminUsersSetOwnerRequest, AdminUsersSetRegularRequest, AdminUsersUnsupportedVersionsExportRequest, AdminWorkflowsCollaboratorsAddRequest, AdminWorkflowsCollaboratorsRemoveRequest, AdminWorkflowsPermissionsLookupRequest, AdminWorkflowsSearchRequest, AdminWorkflowsUnpublishRequest, ApiTestRequest, AppsConnectionsOpenRequest, AppsEventAuthorizationsListRequest, AppsManifestCreateRequest, AppsManifestDeleteRequest, AppsManifestExportRequest, AppsManifestUpdateRequest, AppsManifestValidateRequest, AppsPermissionsInfoRequest, AppsPermissionsRequestRequest, AppsPermissionsResourcesListRequest, AppsPermissionsScopesListRequest, AppsPermissionsUsersListRequest, AppsPermissionsUsersRequestRequest, AppsUninstallRequest, AuthRevokeRequest, AuthTeamsListRequest, AuthTestRequest, BookmarksAddRequest, BookmarksEditRequest, BookmarksListRequest, BookmarksRemoveRequest, BotsInfoRequest, CallsAddRequest, CallsEndRequest, CallsInfoRequest, CallsParticipantsAddRequest, CallsParticipantsRemoveRequest, CallsUpdateRequest, CanvasesAccessDeleteRequest, CanvasesAccessSetRequest, CanvasesCreateRequest, CanvasesDeleteRequest, CanvasesEditRequest, CanvasesSectionsLookupRequest, ChannelsArchiveRequest, ChannelsCreateRequest, ChannelsHistoryRequest, ChannelsInfoRequest, ChannelsInviteRequest, ChannelsJoinRequest, ChannelsKickRequest, ChannelsLeaveRequest, ChannelsListRequest, ChannelsMarkRequest, ChannelsRenameRequest, ChannelsRepliesRequest, ChannelsSetPurposeRequest, ChannelsSetTopicRequest, ChannelsUnarchiveRequest, ChatDeleteRequest, ChatDeleteScheduledMessageRequest, ChatGetPermalinkRequest, ChatMeMessageRequest, ChatPostEphemeralRequest, ChatPostMessageRequest, ChatScheduledMessagesListRequest, ChatScheduleMessageRequest, ChatUnfurlRequest, ChatUpdateRequest, ConversationsAcceptSharedInviteRequest, ConversationsApproveSharedInviteRequest, ConversationsArchiveRequest, ConversationsCanvasesCreateRequest, ConversationsCloseRequest, ConversationsCreateRequest, ConversationsDeclineSharedInviteRequest, ConversationsExternalInvitePermissionsSetRequest, ConversationsHistoryRequest, ConversationsInfoRequest, ConversationsInviteRequest, ConversationsInviteSharedRequest, ConversationsJoinRequest, ConversationsKickRequest, ConversationsLeaveRequest, ConversationsListConnectInvitesRequest, ConversationsListRequest, ConversationsMarkRequest, ConversationsMembersRequest, ConversationsOpenRequest, ConversationsRenameRequest, ConversationsRepliesRequest, ConversationsSetPurposeRequest, ConversationsSetTopicRequest, ConversationsUnarchiveRequest, DialogOpenRequest, DndEndDndRequest, DndEndSnoozeRequest, DndInfoRequest, DndSetSnoozeRequest, DndTeamInfoRequest, EmojiListRequest, FilesCommentsAddRequest, FilesCommentsDeleteRequest, FilesCommentsEditRequest, FilesCompleteUploadExternalRequest, FilesDeleteRequest, FilesGetUploadURLExternalRequest, FilesInfoRequest, FilesListRequest, FilesRemoteAddRequest, FilesRemoteInfoRequest, FilesRemoteListRequest, FilesRemoteRemoveRequest, FilesRemoteShareRequest, FilesRemoteUpdateRequest, FilesRevokePublicURLRequest, FilesSharedPublicURLRequest, FilesUploadRequest, FilesUploadV2Request, FunctionsCompleteErrorRequest, FunctionsCompleteSuccessRequest, GroupsArchiveRequest, GroupsCloseRequest, GroupsCreateChildRequest, GroupsCreateRequest, GroupsHistoryRequest, GroupsInfoRequest, GroupsInviteRequest, GroupsKickRequest, GroupsLeaveRequest, GroupsListRequest, GroupsMarkRequest, GroupsOpenRequest, GroupsRenameRequest, GroupsRepliesRequest, GroupsSetPurposeRequest, GroupsSetTopicRequest, GroupsUnarchiveRequest, ImCloseRequest, ImHistoryRequest, ImListRequest, ImMarkRequest, ImOpenRequest, ImRepliesRequest, MigrationExchangeRequest, MpimCloseRequest, MpimHistoryRequest, MpimListRequest, MpimMarkRequest, MpimOpenRequest, MpimRepliesRequest, OAuthAccessRequest, OAuthTokenRequest, OAuthV2AccessRequest, OAuthV2ExchangeRequest, OpenIDConnectTokenRequest, OpenIDConnectUserInfoRequest, PinsAddRequest, PinsListRequest, PinsRemoveRequest, ReactionsAddRequest, ReactionsGetRequest, ReactionsListRequest, ReactionsRemoveRequest, RemindersAddRequest, RemindersCompleteRequest, RemindersDeleteRequest, RemindersInfoRequest, RemindersListRequest, RTMConnectRequest, RTMStartRequest, SearchAllRequest, SearchFilesRequest, SearchMessagesRequest, StarsAddRequest, StarsListRequest, StarsRemoveRequest, TeamAccessLogsRequest, TeamBillableInfoRequest, TeamBillingInfoRequest, TeamExternalTeamsDisconnectRequest, TeamExternalTeamsListRequest, TeamInfoRequest, TeamIntegrationLogsRequest, TeamPreferencesListRequest, TeamProfileGetRequest, ToolingTokensRotateRequest, UsergroupsCreateRequest, UsergroupsDisableRequest, UsergroupsEnableRequest, UsergroupsListRequest, UsergroupsUpdateRequest, UsergroupsUsersListRequest, UsergroupsUsersUpdateRequest, UsersConversationsRequest, UsersDeletePhotoRequest, UsersDiscoverableContactsLookupRequest, UsersGetPresenceRequest, UsersIdentityRequest, UsersInfoRequest, UsersListRequest, UsersLookupByEmailRequest, UsersProfileGetRequest, UsersProfileSetRequest, UsersSetActiveRequest, UsersSetPhotoRequest, UsersSetPresenceRequest, ViewsOpenRequest, ViewsPublishRequest, ViewsPushRequest, ViewsUpdateRequest, WorkflowsStepCompletedRequest, WorkflowsStepFailedRequest, WorkflowsUpdateStepRequest

public interface SlackApiRequest

A marker interface for Slack API request objects.

Developers can instantiate a request object by either of the following ways: AuthTestRequest req = AuthTestRequest.builder().token("your-token").build(); AuthTestResponse response = Slack.getInstance().methods().authTest(req); or AuthTestResponse response = Slack.getInstance().methods().authTest(req -> req.token("your-token"));

Refer to https://api.slack.com/methods for the API details.

Method Summary

Modifier and Type	Method	Description
String	getToken()	Returns a token in this request object.
default void	setToken(String token)	Updates the token in this request object.

Method Details

getToken

String getToken()

Returns a token in this request object. If the API endpoint does not require a token (e.g., api.test), this method can return null.

Returns:

token string value or null

setToken

default void setToken(String token)

Updates the token in this request object.

The default implementation throws UnsupportedOperationException. All the built-in implementing classes overrides this method in a proper way.

Throws:

UnsupportedOperationException - is always thrown if this method is not overridden