DirectMessagesApi class

Constructors

DirectMessagesApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addDMReaction(String messageId, DMReactionRequest dMReactionRequest) → Future<DMReactionResponse?>
React to a DM message.
addDMReactionWithHttpInfo(String messageId, DMReactionRequest dMReactionRequest) → Future<Response>
React to a DM message.
attachToDMMessage(String messageId, DMAttachRequest dMAttachRequest) → Future<DMMessageEnvelope?>
Attach a file/image/etc. to an existing DM message.
attachToDMMessageWithHttpInfo(String messageId, DMAttachRequest dMAttachRequest) → Future<Response>
Attach a file/image/etc. to an existing DM message.
executeDMAction(ExecuteChatActionRequest executeChatActionRequest) → Future<ExecuteChatActionResponse?>
Dispatch a DM action by id.
executeDMActionWithHttpInfo(ExecuteChatActionRequest executeChatActionRequest) → Future<Response>
Dispatch a DM action by id.
forwardDMMessage(String messageId, DMForwardRequest dMForwardRequest) → Future<DMMessageEnvelope?>
Forward a DM message to another DM or channel.
forwardDMMessageWithHttpInfo(String messageId, DMForwardRequest dMForwardRequest) → Future<Response>
Forward a DM message to another DM or channel.
getDMUser(String id, {String? accountId}) → Future<GetChatUserResponse?>
Fetch one chat user.
getDMUserWithHttpInfo(String id, {String? accountId}) → Future<Response>
Fetch one chat user.
listDirectConversationsEnriched({String? accountId, String? xWorkspaceID}) → Future<Map<String, Object>?>
Enriched DM conversation list with unread + pin + draft state.
listDirectConversationsEnrichedWithHttpInfo({String? accountId, String? xWorkspaceID}) → Future<Response>
Enriched DM conversation list with unread + pin + draft state.
listDirectMessageConversations({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived}) → Future<ListChannelsResponse?>
List 1:1 and group DM conversations.
listDirectMessageConversationsWithHttpInfo({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived}) → Future<Response>
List 1:1 and group DM conversations.
listDirectMessages(String channel, {String? accountId, List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? oldestFirst}) → Future<ListMessagesResponse?>
List messages in a DM conversation.
listDirectMessagesWithHttpInfo(String channel, {String? accountId, List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? oldestFirst}) → Future<Response>
List messages in a DM conversation.
listDMActions() → Future<ChatActionsList?>
Discover the action catalog for DirectMessages.
listDMActionsWithHttpInfo() → Future<Response>
Discover the action catalog for DirectMessages.
listDMPinnedMessages(String dmId, {String? accountId}) → Future<DMPinnedList?>
List pinned messages in a DM conversation.
listDMPinnedMessagesWithHttpInfo(String dmId, {String? accountId}) → Future<Response>
List pinned messages in a DM conversation.
listDMThreadReplies(String dmId, String messageId, {String? accountId}) → Future<Map<String, Object>?>
List replies in a DM message thread.
listDMThreadRepliesWithHttpInfo(String dmId, String messageId, {String? accountId}) → Future<Response>
List replies in a DM message thread.
listDMUsers({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor}) → Future<ListChatUsersResponse?>
List chat users (DM contacts) across connected accounts.
listDMUsersWithHttpInfo({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor}) → Future<Response>
List chat users (DM contacts) across connected accounts.
markDMRead(String dmId, DMMarkReadRequest dMMarkReadRequest) → Future<SuccessFlag?>
Mark a DM message read.
markDMReadWithHttpInfo(String dmId, DMMarkReadRequest dMMarkReadRequest) → Future<Response>
Mark a DM message read.
muteDM(String dmId, DMMuteRequest dMMuteRequest) → Future<DMMuteResponse?>
Mute a DM conversation (until a time, or forever).
muteDMWithHttpInfo(String dmId, DMMuteRequest dMMuteRequest) → Future<Response>
Mute a DM conversation (until a time, or forever).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pinDMConversation(String dmId, {String? accountId}) → Future<SuccessFlag?>
Pin a DM conversation to the top of the sidebar.
pinDMConversationWithHttpInfo(String dmId, {String? accountId}) → Future<Response>
Pin a DM conversation to the top of the sidebar.
pinDMMessage(String messageId, {ChannelMembershipRequest? channelMembershipRequest}) → Future<SuccessFlag?>
Pin a DM message.
pinDMMessageWithHttpInfo(String messageId, {ChannelMembershipRequest? channelMembershipRequest}) → Future<Response>
Pin a DM message.
postDMThreadReply(String dmId, String messageId, DMThreadReplyRequest dMThreadReplyRequest, {String? accountId}) → Future<DMMessageEnvelope?>
Reply in a DM message thread.
postDMThreadReplyWithHttpInfo(String dmId, String messageId, DMThreadReplyRequest dMThreadReplyRequest, {String? accountId}) → Future<Response>
Reply in a DM message thread.
removeDMReaction(String messageId, String emoji, {String? accountId}) → Future<DMReactionResponse?>
Remove a DM message reaction.
removeDMReactionWithHttpInfo(String messageId, String emoji, {String? accountId}) → Future<Response>
Remove a DM message reaction.
searchDirectMessages(String q, {int? limit, String? dmId, String? user, String? accountId}) → Future<DMSearchResults?>
Search across DM messages.
searchDirectMessagesWithHttpInfo(String q, {int? limit, String? dmId, String? user, String? accountId}) → Future<Response>
Search across DM messages.
sendDirectMessage(SendChatMessageRequest sendChatMessageRequest) → Future<SendChatMessageResponse?>
Send a DM.
sendDirectMessageWithHttpInfo(SendChatMessageRequest sendChatMessageRequest) → Future<Response>
Send a DM.
setDMDraft(String dmId, DMSetDraftRequest dMSetDraftRequest) → Future<SuccessFlag?>
Save the unsent draft text for a DM.
setDMDraftWithHttpInfo(String dmId, DMSetDraftRequest dMSetDraftRequest) → Future<Response>
Save the unsent draft text for a DM.
toString() → String
A string representation of this object.
inherited
unpinDMConversation(String dmId, {String? accountId}) → Future<SuccessFlag?>
Unpin a DM conversation.
unpinDMConversationWithHttpInfo(String dmId, {String? accountId}) → Future<Response>
Unpin a DM conversation.
unpinDMMessage(String messageId, {String? accountId}) → Future<SuccessFlag?>
Unpin a DM message.
unpinDMMessageWithHttpInfo(String messageId, {String? accountId}) → Future<Response>
Unpin a DM message.
workspaceExecuteDMAction(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>
Parameters:
workspaceExecuteDMActionWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/direct-messages/execute' operation and returns the Response. Parameters:
workspaceGetDMUser(String org, String workspace, String id) → Future<Map<String, Object>?>
Parameters:
workspaceGetDMUserWithHttpInfo(String org, String workspace, String id) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages/users/{id}' operation and returns the Response. Parameters:
workspaceListDirectMessages(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListDirectMessagesWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages' operation and returns the Response. Parameters:
workspaceListDMActions(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListDMActionsWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages/actions' operation and returns the Response. Parameters:
workspaceListDMConversations(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListDMConversationsWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages/conversations' operation and returns the Response. Parameters:
workspaceListDMMessages(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListDMMessagesWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages/messages' operation and returns the Response. Parameters:
workspaceListDMUsers(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListDMUsersWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/direct-messages/users' operation and returns the Response. Parameters:
workspaceSendDirectMessage(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>
Parameters:
workspaceSendDirectMessageWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/direct-messages/messages' operation and returns the Response. Parameters:

Operators

operator ==(Object other) → bool
The equality operator.
inherited