ChannelsApi class

Constructors

ChannelsApi([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

createChannel(CreateChannelRequest createChannelRequest) → Future<CreateChannelResponse?>
Create a channel.
createChannelWithHttpInfo(CreateChannelRequest createChannelRequest) → Future<Response>
Create a channel.
executeChannelAction(ExecuteChatActionRequest executeChatActionRequest) → Future<ExecuteChatActionResponse?>
Dispatch a channel action by id.
executeChannelActionWithHttpInfo(ExecuteChatActionRequest executeChatActionRequest) → Future<Response>
Dispatch a channel action by id.
joinChannel(String id, {ChannelMembershipRequest? channelMembershipRequest}) → Future<SuccessFlag?>
Join a channel.
joinChannelWithHttpInfo(String id, {ChannelMembershipRequest? channelMembershipRequest}) → Future<Response>
Join a channel.
leaveChannel(String id, {ChannelMembershipRequest? channelMembershipRequest}) → Future<SuccessFlag?>
Leave a channel.
leaveChannelWithHttpInfo(String id, {ChannelMembershipRequest? channelMembershipRequest}) → Future<Response>
Leave a channel.
listChannelActions() → Future<ChatActionsList?>
Discover the action catalog for the Channels platform.
listChannelActionsWithHttpInfo() → Future<Response>
Discover the action catalog for the Channels platform.
listChannelMessages(String channel, {String? accountId, List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? oldestFirst}) → Future<ListMessagesResponse?>
List messages in a channel.
listChannelMessagesWithHttpInfo(String channel, {String? accountId, List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? oldestFirst}) → Future<Response>
List messages in a channel.
listChannels({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived, List<String>? types}) → Future<ListChannelsResponse?>
List group channels across connected chat providers.
listChannelsWithHttpInfo({List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived, List<String>? types}) → Future<Response>
List group channels across connected chat providers.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendChannelMessage(SendChatMessageRequest sendChatMessageRequest) → Future<SendChatMessageResponse?>
Send a message to a channel.
sendChannelMessageWithHttpInfo(SendChatMessageRequest sendChatMessageRequest) → Future<Response>
Send a message to a channel.
toString() → String
A string representation of this object.
inherited
workspaceCreateChannel(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>
Parameters:
workspaceCreateChannelWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/channels' operation and returns the Response. Parameters:
workspaceExecuteChannelAction(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>
Parameters:
workspaceExecuteChannelActionWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/channels/execute' operation and returns the Response. Parameters:
workspaceJoinChannel(String org, String workspace, String id, {Map<String, Object>? requestBody}) → Future<void>
Parameters:
workspaceJoinChannelWithHttpInfo(String org, String workspace, String id, {Map<String, Object>? requestBody}) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/channels/{id}/join' operation and returns the Response. Parameters:
workspaceLeaveChannel(String org, String workspace, String id, {Map<String, Object>? requestBody}) → Future<void>
Parameters:
workspaceLeaveChannelWithHttpInfo(String org, String workspace, String id, {Map<String, Object>? requestBody}) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/channels/{id}/leave' operation and returns the Response. Parameters:
workspaceListChannelActions(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListChannelActionsWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/channels/actions' operation and returns the Response. Parameters:
workspaceListChannelMessages(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListChannelMessagesWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/channels/messages' operation and returns the Response. Parameters:
workspaceListChannels(String org, String workspace) → Future<Map<String, Object>?>
Parameters:
workspaceListChannelsWithHttpInfo(String org, String workspace) → Future<Response>
Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/channels' operation and returns the Response. Parameters:
workspaceSendChannelMessage(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>
Parameters:
workspaceSendChannelMessageWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>
Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/channels/messages' operation and returns the Response. Parameters:

Operators

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