chimesdkmessaging/aws.sdk.kotlin.services.chimesdkmessaging

Package-level declarations

Types

interface ChimeSdkMessagingClient : SdkClient

The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateChannelFlow

inline suspend fun ChimeSdkMessagingClient.associateChannelFlow(crossinline block: AssociateChannelFlowRequest.Builder.() -> Unit): AssociateChannelFlowResponse

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

batchCreateChannelMembership

inline suspend fun ChimeSdkMessagingClient.batchCreateChannelMembership(crossinline block: BatchCreateChannelMembershipRequest.Builder.() -> Unit): BatchCreateChannelMembershipResponse

Adds a specified number of users and bots to a channel.

channelFlowCallback

inline suspend fun ChimeSdkMessagingClient.channelFlowCallback(crossinline block: ChannelFlowCallbackRequest.Builder.() -> Unit): ChannelFlowCallbackResponse

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

createChannel

inline suspend fun ChimeSdkMessagingClient.createChannel(crossinline block: CreateChannelRequest.Builder.() -> Unit): CreateChannelResponse

Creates a channel to which you can add users and send messages.

createChannelBan

inline suspend fun ChimeSdkMessagingClient.createChannelBan(crossinline block: CreateChannelBanRequest.Builder.() -> Unit): CreateChannelBanResponse

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

createChannelFlow

inline suspend fun ChimeSdkMessagingClient.createChannelFlow(crossinline block: CreateChannelFlowRequest.Builder.() -> Unit): CreateChannelFlowResponse

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

createChannelMembership

inline suspend fun ChimeSdkMessagingClient.createChannelMembership(crossinline block: CreateChannelMembershipRequest.Builder.() -> Unit): CreateChannelMembershipResponse

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

createChannelModerator

inline suspend fun ChimeSdkMessagingClient.createChannelModerator(crossinline block: CreateChannelModeratorRequest.Builder.() -> Unit): CreateChannelModeratorResponse

Creates a new ChannelModerator. A channel moderator can:

deleteChannel

inline suspend fun ChimeSdkMessagingClient.deleteChannel(crossinline block: DeleteChannelRequest.Builder.() -> Unit): DeleteChannelResponse

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

deleteChannelBan

inline suspend fun ChimeSdkMessagingClient.deleteChannelBan(crossinline block: DeleteChannelBanRequest.Builder.() -> Unit): DeleteChannelBanResponse

Removes a member from a channel's ban list.

deleteChannelFlow

inline suspend fun ChimeSdkMessagingClient.deleteChannelFlow(crossinline block: DeleteChannelFlowRequest.Builder.() -> Unit): DeleteChannelFlowResponse

Deletes a channel flow, an irreversible process. This is a developer API.

deleteChannelMembership

inline suspend fun ChimeSdkMessagingClient.deleteChannelMembership(crossinline block: DeleteChannelMembershipRequest.Builder.() -> Unit): DeleteChannelMembershipResponse

Removes a member from a channel.

deleteChannelMessage

inline suspend fun ChimeSdkMessagingClient.deleteChannelMessage(crossinline block: DeleteChannelMessageRequest.Builder.() -> Unit): DeleteChannelMessageResponse

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

deleteChannelModerator

inline suspend fun ChimeSdkMessagingClient.deleteChannelModerator(crossinline block: DeleteChannelModeratorRequest.Builder.() -> Unit): DeleteChannelModeratorResponse

Deletes a channel moderator.

deleteMessagingStreamingConfigurations

inline suspend fun ChimeSdkMessagingClient.deleteMessagingStreamingConfigurations(crossinline block: DeleteMessagingStreamingConfigurationsRequest.Builder.() -> Unit): DeleteMessagingStreamingConfigurationsResponse

Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

describeChannel

inline suspend fun ChimeSdkMessagingClient.describeChannel(crossinline block: DescribeChannelRequest.Builder.() -> Unit): DescribeChannelResponse

Returns the full details of a channel in an Amazon Chime AppInstance.

describeChannelBan

inline suspend fun ChimeSdkMessagingClient.describeChannelBan(crossinline block: DescribeChannelBanRequest.Builder.() -> Unit): DescribeChannelBanResponse

Returns the full details of a channel ban.

describeChannelFlow

inline suspend fun ChimeSdkMessagingClient.describeChannelFlow(crossinline block: DescribeChannelFlowRequest.Builder.() -> Unit): DescribeChannelFlowResponse

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

describeChannelMembership

inline suspend fun ChimeSdkMessagingClient.describeChannelMembership(crossinline block: DescribeChannelMembershipRequest.Builder.() -> Unit): DescribeChannelMembershipResponse

Returns the full details of a user's channel membership.

describeChannelMembershipForAppInstanceUser

inline suspend fun ChimeSdkMessagingClient.describeChannelMembershipForAppInstanceUser(crossinline block: DescribeChannelMembershipForAppInstanceUserRequest.Builder.() -> Unit): DescribeChannelMembershipForAppInstanceUserResponse

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

describeChannelModeratedByAppInstanceUser

inline suspend fun ChimeSdkMessagingClient.describeChannelModeratedByAppInstanceUser(crossinline block: DescribeChannelModeratedByAppInstanceUserRequest.Builder.() -> Unit): DescribeChannelModeratedByAppInstanceUserResponse

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

describeChannelModerator

inline suspend fun ChimeSdkMessagingClient.describeChannelModerator(crossinline block: DescribeChannelModeratorRequest.Builder.() -> Unit): DescribeChannelModeratorResponse

Returns the full details of a single ChannelModerator.

disassociateChannelFlow

inline suspend fun ChimeSdkMessagingClient.disassociateChannelFlow(crossinline block: DisassociateChannelFlowRequest.Builder.() -> Unit): DisassociateChannelFlowResponse

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

getChannelMembershipPreferences

inline suspend fun ChimeSdkMessagingClient.getChannelMembershipPreferences(crossinline block: GetChannelMembershipPreferencesRequest.Builder.() -> Unit): GetChannelMembershipPreferencesResponse

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

getChannelMessage

inline suspend fun ChimeSdkMessagingClient.getChannelMessage(crossinline block: GetChannelMessageRequest.Builder.() -> Unit): GetChannelMessageResponse

Gets the full details of a channel message.

getChannelMessageStatus

inline suspend fun ChimeSdkMessagingClient.getChannelMessageStatus(crossinline block: GetChannelMessageStatusRequest.Builder.() -> Unit): GetChannelMessageStatusResponse

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

getMessagingSessionEndpoint

inline suspend fun ChimeSdkMessagingClient.getMessagingSessionEndpoint(crossinline block: GetMessagingSessionEndpointRequest.Builder.() -> Unit): GetMessagingSessionEndpointResponse

The details of the endpoint for the messaging session.

getMessagingStreamingConfigurations

inline suspend fun ChimeSdkMessagingClient.getMessagingStreamingConfigurations(crossinline block: GetMessagingStreamingConfigurationsRequest.Builder.() -> Unit): GetMessagingStreamingConfigurationsResponse

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

listChannelBans

inline suspend fun ChimeSdkMessagingClient.listChannelBans(crossinline block: ListChannelBansRequest.Builder.() -> Unit): ListChannelBansResponse

Lists all the users and bots banned from a particular channel.

listChannelFlows

inline suspend fun ChimeSdkMessagingClient.listChannelFlows(crossinline block: ListChannelFlowsRequest.Builder.() -> Unit): ListChannelFlowsResponse

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

listChannelMemberships

inline suspend fun ChimeSdkMessagingClient.listChannelMemberships(crossinline block: ListChannelMembershipsRequest.Builder.() -> Unit): ListChannelMembershipsResponse

Lists all channel memberships in a channel.

listChannelMembershipsForAppInstanceUser

inline suspend fun ChimeSdkMessagingClient.listChannelMembershipsForAppInstanceUser(crossinline block: ListChannelMembershipsForAppInstanceUserRequest.Builder.() -> Unit): ListChannelMembershipsForAppInstanceUserResponse

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

listChannelMessages

inline suspend fun ChimeSdkMessagingClient.listChannelMessages(crossinline block: ListChannelMessagesRequest.Builder.() -> Unit): ListChannelMessagesResponse

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

listChannelModerators

inline suspend fun ChimeSdkMessagingClient.listChannelModerators(crossinline block: ListChannelModeratorsRequest.Builder.() -> Unit): ListChannelModeratorsResponse

Lists all the moderators for a channel.

listChannels

inline suspend fun ChimeSdkMessagingClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

listChannelsAssociatedWithChannelFlow

inline suspend fun ChimeSdkMessagingClient.listChannelsAssociatedWithChannelFlow(crossinline block: ListChannelsAssociatedWithChannelFlowRequest.Builder.() -> Unit): ListChannelsAssociatedWithChannelFlowResponse

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

listChannelsModeratedByAppInstanceUser

inline suspend fun ChimeSdkMessagingClient.listChannelsModeratedByAppInstanceUser(crossinline block: ListChannelsModeratedByAppInstanceUserRequest.Builder.() -> Unit): ListChannelsModeratedByAppInstanceUserResponse

A list of the channels moderated by an AppInstanceUser.

listSubChannels

inline suspend fun ChimeSdkMessagingClient.listSubChannels(crossinline block: ListSubChannelsRequest.Builder.() -> Unit): ListSubChannelsResponse

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

listTagsForResource

inline suspend fun ChimeSdkMessagingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags applied to an Amazon Chime SDK messaging resource.

putChannelExpirationSettings

inline suspend fun ChimeSdkMessagingClient.putChannelExpirationSettings(crossinline block: PutChannelExpirationSettingsRequest.Builder.() -> Unit): PutChannelExpirationSettingsResponse

Sets the number of days before the channel is automatically deleted.

putChannelMembershipPreferences

inline suspend fun ChimeSdkMessagingClient.putChannelMembershipPreferences(crossinline block: PutChannelMembershipPreferencesRequest.Builder.() -> Unit): PutChannelMembershipPreferencesResponse

Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

putMessagingStreamingConfigurations

inline suspend fun ChimeSdkMessagingClient.putMessagingStreamingConfigurations(crossinline block: PutMessagingStreamingConfigurationsRequest.Builder.() -> Unit): PutMessagingStreamingConfigurationsResponse

Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

redactChannelMessage

inline suspend fun ChimeSdkMessagingClient.redactChannelMessage(crossinline block: RedactChannelMessageRequest.Builder.() -> Unit): RedactChannelMessageResponse

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

searchChannels

inline suspend fun ChimeSdkMessagingClient.searchChannels(crossinline block: SearchChannelsRequest.Builder.() -> Unit): SearchChannelsResponse

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

sendChannelMessage

inline suspend fun ChimeSdkMessagingClient.sendChannelMessage(crossinline block: SendChannelMessageRequest.Builder.() -> Unit): SendChannelMessageResponse

Sends a message to a particular channel that the member is a part of.

tagResource

inline suspend fun ChimeSdkMessagingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

untagResource

inline suspend fun ChimeSdkMessagingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

updateChannel

inline suspend fun ChimeSdkMessagingClient.updateChannel(crossinline block: UpdateChannelRequest.Builder.() -> Unit): UpdateChannelResponse

Update a channel's attributes.

updateChannelFlow

inline suspend fun ChimeSdkMessagingClient.updateChannelFlow(crossinline block: UpdateChannelFlowRequest.Builder.() -> Unit): UpdateChannelFlowResponse

Updates channel flow attributes. This is a developer API.

updateChannelMessage

inline suspend fun ChimeSdkMessagingClient.updateChannelMessage(crossinline block: UpdateChannelMessageRequest.Builder.() -> Unit): UpdateChannelMessageResponse

Updates the content of a message.

updateChannelReadMarker

inline suspend fun ChimeSdkMessagingClient.updateChannelReadMarker(crossinline block: UpdateChannelReadMarkerRequest.Builder.() -> Unit): UpdateChannelReadMarkerResponse

The details of the time when a user last read messages in a channel.

withConfig

fun ChimeSdkMessagingClient.withConfig(block: ChimeSdkMessagingClient.Config.Builder.() -> Unit): ChimeSdkMessagingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.