import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { ChimeSDKMessagingClient } from "./ChimeSDKMessagingClient"; import { AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput } from "./commands/AssociateChannelFlowCommand"; import { BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput } from "./commands/BatchCreateChannelMembershipCommand"; import { ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput } from "./commands/ChannelFlowCallbackCommand"; import { CreateChannelBanCommandInput, CreateChannelBanCommandOutput } from "./commands/CreateChannelBanCommand"; import { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand"; import { CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput } from "./commands/CreateChannelFlowCommand"; import { CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput } from "./commands/CreateChannelMembershipCommand"; import { CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput } from "./commands/CreateChannelModeratorCommand"; import { DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput } from "./commands/DeleteChannelBanCommand"; import { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "./commands/DeleteChannelCommand"; import { DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput } from "./commands/DeleteChannelFlowCommand"; import { DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput } from "./commands/DeleteChannelMembershipCommand"; import { DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput } from "./commands/DeleteChannelMessageCommand"; import { DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput } from "./commands/DeleteChannelModeratorCommand"; import { DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput } from "./commands/DeleteMessagingStreamingConfigurationsCommand"; import { DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput } from "./commands/DescribeChannelBanCommand"; import { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand"; import { DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput } from "./commands/DescribeChannelFlowCommand"; import { DescribeChannelMembershipCommandInput, DescribeChannelMembershipCommandOutput } from "./commands/DescribeChannelMembershipCommand"; import { DescribeChannelMembershipForAppInstanceUserCommandInput, DescribeChannelMembershipForAppInstanceUserCommandOutput } from "./commands/DescribeChannelMembershipForAppInstanceUserCommand"; import { DescribeChannelModeratedByAppInstanceUserCommandInput, DescribeChannelModeratedByAppInstanceUserCommandOutput } from "./commands/DescribeChannelModeratedByAppInstanceUserCommand"; import { DescribeChannelModeratorCommandInput, DescribeChannelModeratorCommandOutput } from "./commands/DescribeChannelModeratorCommand"; import { DisassociateChannelFlowCommandInput, DisassociateChannelFlowCommandOutput } from "./commands/DisassociateChannelFlowCommand"; import { GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPreferencesCommandOutput } from "./commands/GetChannelMembershipPreferencesCommand"; import { GetChannelMessageCommandInput, GetChannelMessageCommandOutput } from "./commands/GetChannelMessageCommand"; import { GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput } from "./commands/GetChannelMessageStatusCommand"; import { GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput } from "./commands/GetMessagingSessionEndpointCommand"; import { GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput } from "./commands/GetMessagingStreamingConfigurationsCommand"; import { ListChannelBansCommandInput, ListChannelBansCommandOutput } from "./commands/ListChannelBansCommand"; import { ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput } from "./commands/ListChannelFlowsCommand"; import { ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput } from "./commands/ListChannelMembershipsCommand"; import { ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput } from "./commands/ListChannelMembershipsForAppInstanceUserCommand"; import { ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput } from "./commands/ListChannelMessagesCommand"; import { ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput } from "./commands/ListChannelModeratorsCommand"; import { ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput } from "./commands/ListChannelsAssociatedWithChannelFlowCommand"; import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/ListChannelsCommand"; import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput } from "./commands/ListChannelsModeratedByAppInstanceUserCommand"; import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand"; import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand"; import { PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput } from "./commands/PutChannelExpirationSettingsCommand"; import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand"; import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand"; import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand"; import { SearchChannelsCommandInput, SearchChannelsCommandOutput } from "./commands/SearchChannelsCommand"; import { SendChannelMessageCommandInput, SendChannelMessageCommandOutput } from "./commands/SendChannelMessageCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand"; import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from "./commands/UpdateChannelFlowCommand"; import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand"; import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand"; /** * @public *

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.

*/ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient { /** * @public *

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.

* *

Only administrators or channel moderators can associate a channel flow. The * x-amz-chime-bearer request header is mandatory. Use the ARN of the * AppInstanceUser or AppInstanceBot * that makes the API call as the value in the header.

* */ associateChannelFlow(args: AssociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; associateChannelFlow(args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void; associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void; /** * @public *

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

*/ batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise; batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void; batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void; /** * @public *

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

*

You can return one of the following processing responses:

* */ channelFlowCallback(args: ChannelFlowCallbackCommandInput, options?: __HttpHandlerOptions): Promise; channelFlowCallback(args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void; channelFlowCallback(args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void; /** * @public *

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

*

* Restriction: You can't change a channel's * privacy.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; /** * @public *

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.

*

If you ban a user who is already part of a channel, that user is automatically kicked * from the channel.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ createChannelBan(args: CreateChannelBanCommandInput, options?: __HttpHandlerOptions): Promise; createChannelBan(args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void; createChannelBan(args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void; /** * @public *

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.

*

Channel flows process the following items:

*
    *
  1. *

    New and updated messages

    *
    2. *
  2. *

    Persistent and non-persistent messages

    *
    3. *
  3. *

    The Standard message type

    *
    4. *
* *

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to * Message types in the Amazon Chime developer guide.

* */ createChannelFlow(args: CreateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; createChannelFlow(args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void; createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void; /** * @public *

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

*
    *
  • *

    List messages

    *
    • *
  • *

    Send messages

    *
    • *
  • *

    Receive messages

    *
    • *
  • *

    Edit their own messages

    *
    • *
  • *

    Leave the channel

    *
    • *
*

Privacy settings impact this action as follows:

*
    *
  • *

    Public Channels: You do not need to be a member to list messages, but you must be * a member to send messages.

    *
    • *
  • *

    Private Channels: You must be a member to list or send messages.

    *
    • *
* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call * as the value in the header.

* */ createChannelMembership(args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise; createChannelMembership(args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void; createChannelMembership(args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void; /** * @public *

Creates a new ChannelModerator. A channel moderator can:

*
    *
  • *

    Add and remove other members of the channel.

    *
    • *
  • *

    Add and remove other moderators of the channel.

    *
    • *
  • *

    Add and remove user bans for the channel.

    *
    • *
  • *

    Redact messages in the channel.

    *
    • *
  • *

    List messages in the channel.

    *
    • *
* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in * the header.

* */ createChannelModerator(args: CreateChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise; createChannelModerator(args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void; createChannelModerator(args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in * the header.

* */ deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; /** * @public *

Removes a member from a channel's ban list.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ deleteChannelBan(args: DeleteChannelBanCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannelBan(args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void; deleteChannelBan(args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void; /** * @public *

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

* *

This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the * ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

* */ deleteChannelFlow(args: DeleteChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannelFlow(args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void; deleteChannelFlow(args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void; /** * @public *

Removes a member from a channel.

* *

The x-amz-chime-bearer request header is mandatory. Use the * AppInstanceUserArn of the user that makes the API call as the value in * the header.

* */ deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannelMembership(args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void; deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ deleteChannelMessage(args: DeleteChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannelMessage(args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void; deleteChannelMessage(args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void; /** * @public *

Deletes a channel moderator.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise; deleteChannelModerator(args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void; deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void; /** * @public *

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

*/ deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise; deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void; deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ describeChannel(args: DescribeChannelCommandInput, options?: __HttpHandlerOptions): Promise; describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; /** * @public *

Returns the full details of a channel ban.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ describeChannelBan(args: DescribeChannelBanCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelBan(args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void; describeChannelBan(args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void; /** * @public *

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

*/ describeChannelFlow(args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelFlow(args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void; describeChannelFlow(args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ describeChannelMembership(args: DescribeChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelMembership(args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void; describeChannelMembership(args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void; describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void; describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void; /** * @public *

Returns the full details of a single ChannelModerator.

* *

The x-amz-chime-bearer request header is mandatory. Use the * AppInstanceUserArn of the user that makes the API call as the value in * the header.

* */ describeChannelModerator(args: DescribeChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise; describeChannelModerator(args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void; describeChannelModerator(args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void; /** * @public *

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

* *

Only administrators or channel moderators can disassociate a channel flow.

*

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void; disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void; /** * @public *

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 to be able * 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.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise; getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void; getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void; /** * @public *

Gets the full details of a channel message.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ getChannelMessage(args: GetChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise; getChannelMessage(args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void; getChannelMessage(args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void; /** * @public *

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.

*

Messages can have any one of these statuses.

*
*
SENT
*
*

Message processed successfully

*
*
PENDING
*
*

Ongoing processing

*
*
FAILED
*
*

Processing failed

*
*
DENIED
*
*

Messasge denied by the processor

*
*
* *
    *
  • *

    This API does not return statuses for denied messages, because we don't store them once the processor denies them.

    *
    • *
  • *

    Only the message sender can invoke this API.

    *
    • *
  • *

    The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

    *
    • *
* */ getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options?: __HttpHandlerOptions): Promise; getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void; getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void; /** * @public *

The details of the endpoint for the messaging session.

*/ getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions): Promise; getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void; getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void; /** * @public *

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

*/ getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise; getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void; getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannelBans(args: ListChannelBansCommandInput, options?: __HttpHandlerOptions): Promise; listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void; listChannelBans(args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void; /** * @public *

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

*/ listChannelFlows(args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions): Promise; listChannelFlows(args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void; listChannelFlows(args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void; /** * @public *

Lists all channel memberships in a channel.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* *

If you want to list the channels to which a specific app instance user belongs, see the * ListChannelMembershipsForAppInstanceUser API.

*/ listChannelMemberships(args: ListChannelMembershipsCommandInput, options?: __HttpHandlerOptions): Promise; listChannelMemberships(args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void; listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise; listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void; listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void; /** * @public *

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

* *

Redacted messages appear in the results as empty, since they are only redacted, not * deleted. Deleted messages do not appear in the results. This action always returns the * latest version of an edited message.

*

Also, the x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannelMessages(args: ListChannelMessagesCommandInput, options?: __HttpHandlerOptions): Promise; listChannelMessages(args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void; listChannelMessages(args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void; /** * @public *

Lists all the moderators for a channel.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannelModerators(args: ListChannelModeratorsCommandInput, options?: __HttpHandlerOptions): Promise; listChannelModerators(args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void; listChannelModerators(args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void; /** * @public *

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

*

* Functionality & restrictions *

*
    *
  • *

    Use privacy = PUBLIC to retrieve all public channels in the * account.

    *
    • *
  • *

    Only an AppInstanceAdmin can set privacy = PRIVATE to * list the private channels in an account.

    *
    • *
* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; /** * @public *

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.

*/ listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void; listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void; /** * @public *

A list of the channels moderated by an AppInstanceUser.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise; listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void; listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void; /** * @public *

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.

*/ listSubChannels(args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions): Promise; listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void; listSubChannels(args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void; /** * @public *

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

*/ listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise; listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void; listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void; /** * @public *

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

* *
    *
  • *

    A background process deletes expired channels within 6 hours of expiration. * Actual deletion times may vary.

    *
    • *
  • *

    Expired channels that have not yet been deleted appear as active, and you can update * their expiration settings. The system honors the new settings.

    *
    • *
  • *

    The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

    *
    • *
* */ putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options?: __HttpHandlerOptions): Promise; putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void; putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void; /** * @public *

Sets the membership preferences of an AppInstanceUser or AppIntanceBot * 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 or users. Banned users or bots can't set membership preferences for the channel from * which they are banned.

* *

The x-amz-chime-bearer request header is mandatory. Use the ARN of an * AppInstanceUser or AppInstanceBot that makes the API call as the value in the * header.

* */ putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise; putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void; putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void; /** * @public *

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

*/ putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise; putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void; putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void; /** * @public *

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.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ redactChannelMessage(args: RedactChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise; redactChannelMessage(args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void; redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void; /** * @public *

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.

*

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

*/ searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise; searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void; searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

*

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. * CONTROL messages can contain 30 bytes of data and no metadata.

* */ sendChannelMessage(args: SendChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise; sendChannelMessage(args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void; sendChannelMessage(args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void; /** * @public *

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

*/ tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void; /** * @public *

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

*/ untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; /** * @public *

Update a channel's attributes.

*

* Restriction: You can't change a channel's privacy.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; /** * @public *

Updates channel flow attributes. This is a developer API.

*/ updateChannelFlow(args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise; updateChannelFlow(args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void; updateChannelFlow(args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void; /** * @public *

Updates the content of a message.

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ updateChannelMessage(args: UpdateChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise; updateChannelMessage(args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void; updateChannelMessage(args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void; /** * @public *

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

* *

The x-amz-chime-bearer request header is mandatory. Use the * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in * the header.

* */ updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, options?: __HttpHandlerOptions): Promise; updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void): void; updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void): void; }