@aws-sdk/client-chime-sdk-messaging 3.296.0 → 3.298.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/ChimeSDKMessaging.js +15 -0
- package/dist-cjs/commands/AssociateChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/BatchCreateChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/ChannelFlowCallbackCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelBanCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelModeratorCommand.js +1 -1
- package/dist-cjs/commands/DeleteChannelBanCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelMembershipCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelMessageCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelModeratorCommand.js +2 -3
- package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/DescribeChannelBanCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelModeratorCommand.js +1 -1
- package/dist-cjs/commands/DisassociateChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/GetChannelMembershipPreferencesCommand.js +1 -1
- package/dist-cjs/commands/GetChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/GetChannelMessageStatusCommand.js +2 -3
- package/dist-cjs/commands/GetMessagingSessionEndpointCommand.js +2 -3
- package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/ListTagsForResourceCommand.js +1 -1
- package/dist-cjs/commands/PutChannelExpirationSettingsCommand.js +45 -0
- package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/RedactChannelMessageCommand.js +2 -3
- package/dist-cjs/commands/SendChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/TagResourceCommand.js +1 -1
- package/dist-cjs/commands/UntagResourceCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelReadMarkerCommand.js +2 -3
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +12 -211
- package/dist-cjs/protocols/Aws_restJson1.js +107 -2
- package/dist-es/ChimeSDKMessaging.js +15 -0
- package/dist-es/commands/AssociateChannelFlowCommand.js +2 -3
- package/dist-es/commands/BatchCreateChannelMembershipCommand.js +2 -2
- package/dist-es/commands/ChannelFlowCallbackCommand.js +2 -2
- package/dist-es/commands/CreateChannelBanCommand.js +2 -2
- package/dist-es/commands/CreateChannelCommand.js +2 -2
- package/dist-es/commands/CreateChannelFlowCommand.js +2 -2
- package/dist-es/commands/CreateChannelMembershipCommand.js +2 -2
- package/dist-es/commands/CreateChannelModeratorCommand.js +2 -2
- package/dist-es/commands/DeleteChannelBanCommand.js +2 -3
- package/dist-es/commands/DeleteChannelCommand.js +2 -3
- package/dist-es/commands/DeleteChannelFlowCommand.js +2 -3
- package/dist-es/commands/DeleteChannelMembershipCommand.js +2 -3
- package/dist-es/commands/DeleteChannelMessageCommand.js +2 -3
- package/dist-es/commands/DeleteChannelModeratorCommand.js +2 -3
- package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/DescribeChannelBanCommand.js +2 -2
- package/dist-es/commands/DescribeChannelCommand.js +2 -2
- package/dist-es/commands/DescribeChannelFlowCommand.js +2 -2
- package/dist-es/commands/DescribeChannelMembershipCommand.js +2 -2
- package/dist-es/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +2 -2
- package/dist-es/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +2 -2
- package/dist-es/commands/DescribeChannelModeratorCommand.js +2 -2
- package/dist-es/commands/DisassociateChannelFlowCommand.js +2 -3
- package/dist-es/commands/GetChannelMembershipPreferencesCommand.js +2 -2
- package/dist-es/commands/GetChannelMessageCommand.js +2 -2
- package/dist-es/commands/GetChannelMessageStatusCommand.js +2 -3
- package/dist-es/commands/GetMessagingSessionEndpointCommand.js +2 -3
- package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
- package/dist-es/commands/PutChannelExpirationSettingsCommand.js +41 -0
- package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/RedactChannelMessageCommand.js +2 -3
- package/dist-es/commands/SendChannelMessageCommand.js +2 -2
- package/dist-es/commands/TagResourceCommand.js +1 -1
- package/dist-es/commands/UntagResourceCommand.js +1 -1
- package/dist-es/commands/UpdateChannelCommand.js +2 -2
- package/dist-es/commands/UpdateChannelFlowCommand.js +2 -2
- package/dist-es/commands/UpdateChannelMessageCommand.js +2 -2
- package/dist-es/commands/UpdateChannelReadMarkerCommand.js +2 -3
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +10 -156
- package/dist-es/protocols/Aws_restJson1.js +102 -0
- package/dist-types/ChimeSDKMessaging.d.ts +151 -50
- package/dist-types/ChimeSDKMessagingClient.d.ts +27 -6
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +20 -2
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +17 -1
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelBanCommand.d.ts +17 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +17 -1
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +20 -4
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +17 -1
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +18 -2
- package/dist-types/commands/DeleteChannelCommand.d.ts +17 -1
- package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +17 -1
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +17 -1
- package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +17 -1
- package/dist-types/commands/DescribeChannelCommand.d.ts +17 -1
- package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +17 -1
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +18 -2
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +18 -2
- package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +20 -2
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +26 -3
- package/dist-types/commands/GetChannelMessageCommand.d.ts +18 -2
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +19 -1
- package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
- package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelBansCommand.d.ts +18 -2
- package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +17 -1
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +19 -3
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +18 -2
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +17 -1
- package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +17 -1
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +17 -1
- package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts +99 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +26 -3
- package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +17 -1
- package/dist-types/commands/SearchChannelsCommand.d.ts +22 -1
- package/dist-types/commands/SendChannelMessageCommand.d.ts +17 -1
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +17 -1
- package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +17 -1
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +17 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +504 -250
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +17 -0
- package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/PutChannelExpirationSettingsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +25 -155
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +4 -3
|
@@ -39,6 +39,7 @@ import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/
|
|
|
39
39
|
import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput } from "./commands/ListChannelsModeratedByAppInstanceUserCommand";
|
|
40
40
|
import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
|
|
41
41
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
42
|
+
import { PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput } from "./commands/PutChannelExpirationSettingsCommand";
|
|
42
43
|
import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
|
|
43
44
|
import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
|
|
44
45
|
import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
|
|
@@ -51,6 +52,7 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
|
|
|
51
52
|
import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
|
|
52
53
|
import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
|
|
53
54
|
/**
|
|
55
|
+
* @public
|
|
54
56
|
* <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
|
|
55
57
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
56
58
|
* provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
|
|
@@ -58,23 +60,28 @@ import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutp
|
|
|
58
60
|
*/
|
|
59
61
|
export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
60
62
|
/**
|
|
63
|
+
* @public
|
|
61
64
|
* <p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
|
|
62
65
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
63
66
|
* <note>
|
|
64
|
-
* <p>Only administrators or channel moderators can associate a channel flow. The
|
|
65
|
-
*
|
|
67
|
+
* <p>Only administrators or channel moderators can associate a channel flow. The
|
|
68
|
+
* <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the
|
|
69
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
70
|
+
* that makes the API call as the value in the header.</p>
|
|
66
71
|
* </note>
|
|
67
72
|
*/
|
|
68
73
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<AssociateChannelFlowCommandOutput>;
|
|
69
74
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
70
75
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
71
76
|
/**
|
|
72
|
-
*
|
|
77
|
+
* @public
|
|
78
|
+
* <p>Adds a specified number of users and bots to a channel. </p>
|
|
73
79
|
*/
|
|
74
80
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateChannelMembershipCommandOutput>;
|
|
75
81
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
76
82
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
77
83
|
/**
|
|
84
|
+
* @public
|
|
78
85
|
* <p>Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.</p>
|
|
79
86
|
* <p>You can return one of the following processing responses:</p>
|
|
80
87
|
* <ul>
|
|
@@ -93,13 +100,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
93
100
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
94
101
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
95
102
|
/**
|
|
103
|
+
* @public
|
|
96
104
|
* <p>Creates a channel to which you can add users and send messages.</p>
|
|
97
105
|
* <p>
|
|
98
106
|
* <b>Restriction</b>: You can't change a channel's
|
|
99
107
|
* privacy.</p>
|
|
100
108
|
* <note>
|
|
101
109
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
102
|
-
*
|
|
110
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
103
111
|
* the header.</p>
|
|
104
112
|
* </note>
|
|
105
113
|
*/
|
|
@@ -107,6 +115,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
107
115
|
createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
108
116
|
createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
109
117
|
/**
|
|
118
|
+
* @public
|
|
110
119
|
* <p>Permanently bans a member from a channel. Moderators can't add banned members to a
|
|
111
120
|
* channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
|
|
112
121
|
* <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
|
|
@@ -115,7 +124,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
115
124
|
* from the channel.</p>
|
|
116
125
|
* <note>
|
|
117
126
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
118
|
-
* <code>
|
|
127
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
119
128
|
* the header.</p>
|
|
120
129
|
* </note>
|
|
121
130
|
*/
|
|
@@ -123,6 +132,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
123
132
|
createChannelBan(args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
124
133
|
createChannelBan(args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
125
134
|
/**
|
|
135
|
+
* @public
|
|
126
136
|
* <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
|
|
127
137
|
* that perform actions on chat messages, such as stripping out profanity. You can associate
|
|
128
138
|
* channel flows with channels, and the processors in the channel flow then take action on all
|
|
@@ -148,8 +158,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
148
158
|
createChannelFlow(args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
149
159
|
createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
150
160
|
/**
|
|
151
|
-
*
|
|
152
|
-
*
|
|
161
|
+
* @public
|
|
162
|
+
* <p>Adds a member to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code>
|
|
163
|
+
* is derived from the request header. A channel member can:</p>
|
|
153
164
|
* <ul>
|
|
154
165
|
* <li>
|
|
155
166
|
* <p>List messages</p>
|
|
@@ -179,14 +190,15 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
179
190
|
* </ul>
|
|
180
191
|
* <note>
|
|
181
192
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
182
|
-
* <code>AppInstanceUserArn</code>
|
|
183
|
-
* the header.</p>
|
|
193
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call
|
|
194
|
+
* as the value in the header.</p>
|
|
184
195
|
* </note>
|
|
185
196
|
*/
|
|
186
197
|
createChannelMembership(args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelMembershipCommandOutput>;
|
|
187
198
|
createChannelMembership(args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
188
199
|
createChannelMembership(args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
189
200
|
/**
|
|
201
|
+
* @public
|
|
190
202
|
* <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
|
|
191
203
|
* <ul>
|
|
192
204
|
* <li>
|
|
@@ -207,7 +219,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
207
219
|
* </ul>
|
|
208
220
|
* <note>
|
|
209
221
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
210
|
-
* <code>
|
|
222
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in
|
|
211
223
|
* the header.</p>
|
|
212
224
|
* </note>
|
|
213
225
|
*/
|
|
@@ -215,11 +227,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
215
227
|
createChannelModerator(args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
216
228
|
createChannelModerator(args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
217
229
|
/**
|
|
230
|
+
* @public
|
|
218
231
|
* <p>Immediately makes a channel and its memberships inaccessible and marks them for
|
|
219
232
|
* deletion. This is an irreversible process.</p>
|
|
220
233
|
* <note>
|
|
221
234
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
222
|
-
* <code>AppInstanceUserArn</code>
|
|
235
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
223
236
|
* the header.</p>
|
|
224
237
|
* </note>
|
|
225
238
|
*/
|
|
@@ -227,10 +240,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
227
240
|
deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
228
241
|
deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
229
242
|
/**
|
|
230
|
-
*
|
|
243
|
+
* @public
|
|
244
|
+
* <p>Removes a member from a channel's ban list.</p>
|
|
231
245
|
* <note>
|
|
232
246
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
233
|
-
*
|
|
247
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
234
248
|
* the header.</p>
|
|
235
249
|
* </note>
|
|
236
250
|
*/
|
|
@@ -238,6 +252,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
238
252
|
deleteChannelBan(args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
239
253
|
deleteChannelBan(args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
240
254
|
/**
|
|
255
|
+
* @public
|
|
241
256
|
* <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
|
|
242
257
|
* <note>
|
|
243
258
|
* <p> 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
|
|
@@ -248,6 +263,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
248
263
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
249
264
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
250
265
|
/**
|
|
266
|
+
* @public
|
|
251
267
|
* <p>Removes a member from a channel.</p>
|
|
252
268
|
* <note>
|
|
253
269
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -259,12 +275,13 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
259
275
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
260
276
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
261
277
|
/**
|
|
278
|
+
* @public
|
|
262
279
|
* <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
|
|
263
280
|
* inaccessible immediately. A background process deletes any revisions created by
|
|
264
281
|
* <code>UpdateChannelMessage</code>.</p>
|
|
265
282
|
* <note>
|
|
266
283
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
267
|
-
*
|
|
284
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
268
285
|
* the header.</p>
|
|
269
286
|
* </note>
|
|
270
287
|
*/
|
|
@@ -272,10 +289,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
272
289
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
273
290
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
274
291
|
/**
|
|
292
|
+
* @public
|
|
275
293
|
* <p>Deletes a channel moderator.</p>
|
|
276
294
|
* <note>
|
|
277
295
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
278
|
-
*
|
|
296
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
279
297
|
* the header.</p>
|
|
280
298
|
* </note>
|
|
281
299
|
*/
|
|
@@ -283,6 +301,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
283
301
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
284
302
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
285
303
|
/**
|
|
304
|
+
* @public
|
|
286
305
|
* <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
|
|
287
306
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
288
307
|
*/
|
|
@@ -290,11 +309,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
290
309
|
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
291
310
|
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
292
311
|
/**
|
|
312
|
+
* @public
|
|
293
313
|
* <p>Returns the full details of a channel in an Amazon Chime
|
|
294
314
|
* <code>AppInstance</code>.</p>
|
|
295
315
|
* <note>
|
|
296
316
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
297
|
-
*
|
|
317
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
298
318
|
* the header.</p>
|
|
299
319
|
* </note>
|
|
300
320
|
*/
|
|
@@ -302,10 +322,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
302
322
|
describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
303
323
|
describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
304
324
|
/**
|
|
325
|
+
* @public
|
|
305
326
|
* <p>Returns the full details of a channel ban.</p>
|
|
306
327
|
* <note>
|
|
307
328
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
308
|
-
*
|
|
329
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
309
330
|
* the header.</p>
|
|
310
331
|
* </note>
|
|
311
332
|
*/
|
|
@@ -313,16 +334,18 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
313
334
|
describeChannelBan(args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
314
335
|
describeChannelBan(args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
315
336
|
/**
|
|
337
|
+
* @public
|
|
316
338
|
* <p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</p>
|
|
317
339
|
*/
|
|
318
340
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelFlowCommandOutput>;
|
|
319
341
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
320
342
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
321
343
|
/**
|
|
344
|
+
* @public
|
|
322
345
|
* <p>Returns the full details of a user's channel membership.</p>
|
|
323
346
|
* <note>
|
|
324
347
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
325
|
-
*
|
|
348
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
326
349
|
* the header.</p>
|
|
327
350
|
* </note>
|
|
328
351
|
*/
|
|
@@ -330,11 +353,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
330
353
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
331
354
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
332
355
|
/**
|
|
356
|
+
* @public
|
|
333
357
|
* <p> Returns the details of a channel based on the membership of the specified
|
|
334
|
-
* <code>AppInstanceUser</code>.</p>
|
|
358
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
|
|
335
359
|
* <note>
|
|
336
360
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
337
|
-
*
|
|
361
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
338
362
|
* the header.</p>
|
|
339
363
|
* </note>
|
|
340
364
|
*/
|
|
@@ -342,11 +366,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
342
366
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
343
367
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
344
368
|
/**
|
|
369
|
+
* @public
|
|
345
370
|
* <p>Returns the full details of a channel moderated by the specified
|
|
346
|
-
* <code>AppInstanceUser</code>.</p>
|
|
371
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
|
|
347
372
|
* <note>
|
|
348
373
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
349
|
-
*
|
|
374
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
350
375
|
* the header.</p>
|
|
351
376
|
* </note>
|
|
352
377
|
*/
|
|
@@ -354,6 +379,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
354
379
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
355
380
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
356
381
|
/**
|
|
382
|
+
* @public
|
|
357
383
|
* <p>Returns the full details of a single ChannelModerator.</p>
|
|
358
384
|
* <note>
|
|
359
385
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -365,29 +391,41 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
365
391
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
366
392
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
367
393
|
/**
|
|
394
|
+
* @public
|
|
368
395
|
* <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
|
|
369
396
|
* that channel stop going through the channel flow processor.</p>
|
|
370
397
|
* <note>
|
|
371
|
-
* <p>Only administrators or channel moderators can disassociate a channel flow
|
|
372
|
-
*
|
|
398
|
+
* <p>Only administrators or channel moderators can disassociate a channel flow.</p>
|
|
399
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
400
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
401
|
+
* the header.</p>
|
|
373
402
|
* </note>
|
|
374
403
|
*/
|
|
375
404
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateChannelFlowCommandOutput>;
|
|
376
405
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
377
406
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
378
407
|
/**
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
*
|
|
408
|
+
* @public
|
|
409
|
+
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
410
|
+
* for the specified channel. A user or a bot must be a member of the channel and own the membership to be able
|
|
411
|
+
* to retrieve membership preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't
|
|
412
|
+
* retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
|
|
413
|
+
* channel from which they are banned.</p>
|
|
414
|
+
* <note>
|
|
415
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
416
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
417
|
+
* the header.</p>
|
|
418
|
+
* </note>
|
|
382
419
|
*/
|
|
383
420
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMembershipPreferencesCommandOutput>;
|
|
384
421
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
385
422
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
386
423
|
/**
|
|
424
|
+
* @public
|
|
387
425
|
* <p>Gets the full details of a channel message.</p>
|
|
388
426
|
* <note>
|
|
389
|
-
* <p>The x-amz-chime-bearer request header is mandatory. Use the
|
|
390
|
-
*
|
|
427
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
428
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
391
429
|
* the header.</p>
|
|
392
430
|
* </note>
|
|
393
431
|
*/
|
|
@@ -395,6 +433,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
395
433
|
getChannelMessage(args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
396
434
|
getChannelMessage(args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
397
435
|
/**
|
|
436
|
+
* @public
|
|
398
437
|
* <p>Gets message status for a specified <code>messageId</code>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to
|
|
399
438
|
* retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
|
|
400
439
|
* <p>Messages can have any one of these statuses.</p>
|
|
@@ -425,7 +464,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
425
464
|
* <p>Only the message sender can invoke this API.</p>
|
|
426
465
|
* </li>
|
|
427
466
|
* <li>
|
|
428
|
-
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
467
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
468
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
469
|
+
* the header.</p>
|
|
429
470
|
* </li>
|
|
430
471
|
* </ul>
|
|
431
472
|
* </note>
|
|
@@ -434,12 +475,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
434
475
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
435
476
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
436
477
|
/**
|
|
478
|
+
* @public
|
|
437
479
|
* <p>The details of the endpoint for the messaging session.</p>
|
|
438
480
|
*/
|
|
439
481
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingSessionEndpointCommandOutput>;
|
|
440
482
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
441
483
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
442
484
|
/**
|
|
485
|
+
* @public
|
|
443
486
|
* <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
444
487
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
445
488
|
*/
|
|
@@ -447,10 +490,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
447
490
|
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
448
491
|
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
449
492
|
/**
|
|
450
|
-
*
|
|
493
|
+
* @public
|
|
494
|
+
* <p>Lists all the users and bots banned from a particular channel.</p>
|
|
451
495
|
* <note>
|
|
452
496
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
453
|
-
*
|
|
497
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
454
498
|
* the header.</p>
|
|
455
499
|
* </note>
|
|
456
500
|
*/
|
|
@@ -458,16 +502,18 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
458
502
|
listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
459
503
|
listChannelBans(args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
460
504
|
/**
|
|
505
|
+
* @public
|
|
461
506
|
* <p>Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.</p>
|
|
462
507
|
*/
|
|
463
508
|
listChannelFlows(args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelFlowsCommandOutput>;
|
|
464
509
|
listChannelFlows(args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
465
510
|
listChannelFlows(args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
466
511
|
/**
|
|
512
|
+
* @public
|
|
467
513
|
* <p>Lists all channel memberships in a channel.</p>
|
|
468
514
|
* <note>
|
|
469
515
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
470
|
-
*
|
|
516
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
471
517
|
* the header.</p>
|
|
472
518
|
* </note>
|
|
473
519
|
* <p>If you want to list the channels to which a specific app instance user belongs, see the
|
|
@@ -477,11 +523,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
477
523
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
478
524
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
479
525
|
/**
|
|
480
|
-
*
|
|
481
|
-
*
|
|
526
|
+
* @public
|
|
527
|
+
* <p> Lists all channels that anr <code>AppInstanceUser</code> or <code>AppInstanceBot</code> is a part of.
|
|
528
|
+
* Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
|
|
482
529
|
* <note>
|
|
483
530
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
484
|
-
*
|
|
531
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
485
532
|
* the header.</p>
|
|
486
533
|
* </note>
|
|
487
534
|
*/
|
|
@@ -489,6 +536,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
489
536
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
490
537
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
491
538
|
/**
|
|
539
|
+
* @public
|
|
492
540
|
* <p>List all the messages in a channel. Returns a paginated list of
|
|
493
541
|
* <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending
|
|
494
542
|
* order.</p>
|
|
@@ -496,8 +544,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
496
544
|
* <p>Redacted messages appear in the results as empty, since they are only redacted, not
|
|
497
545
|
* deleted. Deleted messages do not appear in the results. This action always returns the
|
|
498
546
|
* latest version of an edited message.</p>
|
|
499
|
-
* <p>Also, the x-amz-chime-bearer request header is mandatory. Use the
|
|
500
|
-
*
|
|
547
|
+
* <p>Also, the <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
548
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
501
549
|
* the header.</p>
|
|
502
550
|
* </note>
|
|
503
551
|
*/
|
|
@@ -505,10 +553,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
505
553
|
listChannelMessages(args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
506
554
|
listChannelMessages(args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
507
555
|
/**
|
|
556
|
+
* @public
|
|
508
557
|
* <p>Lists all the moderators for a channel.</p>
|
|
509
558
|
* <note>
|
|
510
559
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
511
|
-
*
|
|
560
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
512
561
|
* the header.</p>
|
|
513
562
|
* </note>
|
|
514
563
|
*/
|
|
@@ -516,6 +565,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
516
565
|
listChannelModerators(args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
517
566
|
listChannelModerators(args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
518
567
|
/**
|
|
568
|
+
* @public
|
|
519
569
|
* <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
|
|
520
570
|
* filters to narrow results.</p>
|
|
521
571
|
* <p class="title">
|
|
@@ -533,7 +583,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
533
583
|
* </ul>
|
|
534
584
|
* <note>
|
|
535
585
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
536
|
-
*
|
|
586
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
537
587
|
* the header.</p>
|
|
538
588
|
* </note>
|
|
539
589
|
*/
|
|
@@ -541,16 +591,18 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
541
591
|
listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
542
592
|
listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
543
593
|
/**
|
|
594
|
+
* @public
|
|
544
595
|
* <p>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.</p>
|
|
545
596
|
*/
|
|
546
597
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsAssociatedWithChannelFlowCommandOutput>;
|
|
547
598
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
548
599
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
549
600
|
/**
|
|
601
|
+
* @public
|
|
550
602
|
* <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
|
|
551
603
|
* <note>
|
|
552
604
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
553
|
-
*
|
|
605
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
554
606
|
* the header.</p>
|
|
555
607
|
* </note>
|
|
556
608
|
*/
|
|
@@ -558,26 +610,61 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
558
610
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
559
611
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
560
612
|
/**
|
|
613
|
+
* @public
|
|
561
614
|
* <p>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.</p>
|
|
562
615
|
*/
|
|
563
616
|
listSubChannels(args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubChannelsCommandOutput>;
|
|
564
617
|
listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
565
618
|
listSubChannels(args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
566
619
|
/**
|
|
620
|
+
* @public
|
|
567
621
|
* <p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>
|
|
568
622
|
*/
|
|
569
623
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
570
624
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
571
625
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
572
626
|
/**
|
|
573
|
-
*
|
|
574
|
-
*
|
|
575
|
-
*
|
|
627
|
+
* @public
|
|
628
|
+
* <p>Sets the number of days before the channel is automatically deleted.</p>
|
|
629
|
+
* <note>
|
|
630
|
+
* <ul>
|
|
631
|
+
* <li>
|
|
632
|
+
* <p>A background process deletes expired channels within 6 hours of expiration.
|
|
633
|
+
* Actual deletion times may vary.</p>
|
|
634
|
+
* </li>
|
|
635
|
+
* <li>
|
|
636
|
+
* <p>Expired channels that have not yet been deleted appear as active, and you can update
|
|
637
|
+
* their expiration settings. The system honors the new settings.</p>
|
|
638
|
+
* </li>
|
|
639
|
+
* <li>
|
|
640
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
641
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
642
|
+
* the header.</p>
|
|
643
|
+
* </li>
|
|
644
|
+
* </ul>
|
|
645
|
+
* </note>
|
|
646
|
+
*/
|
|
647
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelExpirationSettingsCommandOutput>;
|
|
648
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
|
|
649
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
|
|
650
|
+
/**
|
|
651
|
+
* @public
|
|
652
|
+
* <p>Sets the membership preferences of an <code>AppInstanceUser</code> or <code>AppIntanceBot</code>
|
|
653
|
+
* for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the
|
|
654
|
+
* membership can set preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't set
|
|
655
|
+
* preferences for other users or users. Banned users or bots can't set membership preferences for the channel from
|
|
656
|
+
* which they are banned.</p>
|
|
657
|
+
* <note>
|
|
658
|
+
* <p>The x-amz-chime-bearer request header is mandatory. Use the ARN of an
|
|
659
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the
|
|
660
|
+
* header.</p>
|
|
661
|
+
* </note>
|
|
576
662
|
*/
|
|
577
663
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelMembershipPreferencesCommandOutput>;
|
|
578
664
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
579
665
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
580
666
|
/**
|
|
667
|
+
* @public
|
|
581
668
|
* <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
582
669
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
583
670
|
*/
|
|
@@ -585,11 +672,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
585
672
|
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
586
673
|
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
587
674
|
/**
|
|
675
|
+
* @public
|
|
588
676
|
* <p>Redacts message content, but not metadata. The message exists in the back end, but the
|
|
589
677
|
* action returns null content, and the state shows as redacted.</p>
|
|
590
678
|
* <note>
|
|
591
679
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
592
|
-
*
|
|
680
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
593
681
|
* the header.</p>
|
|
594
682
|
* </note>
|
|
595
683
|
*/
|
|
@@ -597,16 +685,23 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
597
685
|
redactChannelMessage(args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
598
686
|
redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
599
687
|
/**
|
|
600
|
-
*
|
|
688
|
+
* @public
|
|
689
|
+
* <p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search
|
|
690
|
+
* across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across
|
|
691
|
+
* all channels.</p>
|
|
692
|
+
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
693
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
694
|
+
* the header.</p>
|
|
601
695
|
*/
|
|
602
696
|
searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
|
|
603
697
|
searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
604
698
|
searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
605
699
|
/**
|
|
700
|
+
* @public
|
|
606
701
|
* <p>Sends a message to a particular channel that the member is a part of.</p>
|
|
607
702
|
* <note>
|
|
608
703
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
609
|
-
*
|
|
704
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
610
705
|
* the header.</p>
|
|
611
706
|
* <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
|
|
612
707
|
* <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
|
|
@@ -616,24 +711,27 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
616
711
|
sendChannelMessage(args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
617
712
|
sendChannelMessage(args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
618
713
|
/**
|
|
714
|
+
* @public
|
|
619
715
|
* <p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>
|
|
620
716
|
*/
|
|
621
717
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
622
718
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
623
719
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
624
720
|
/**
|
|
721
|
+
* @public
|
|
625
722
|
* <p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>
|
|
626
723
|
*/
|
|
627
724
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
628
725
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
629
726
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
630
727
|
/**
|
|
728
|
+
* @public
|
|
631
729
|
* <p>Update a channel's attributes.</p>
|
|
632
730
|
* <p>
|
|
633
731
|
* <b>Restriction</b>: You can't change a channel's privacy. </p>
|
|
634
732
|
* <note>
|
|
635
733
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
636
|
-
*
|
|
734
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
637
735
|
* the header.</p>
|
|
638
736
|
* </note>
|
|
639
737
|
*/
|
|
@@ -641,16 +739,18 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
641
739
|
updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
642
740
|
updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
643
741
|
/**
|
|
742
|
+
* @public
|
|
644
743
|
* <p>Updates channel flow attributes. This is a developer API.</p>
|
|
645
744
|
*/
|
|
646
745
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelFlowCommandOutput>;
|
|
647
746
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
648
747
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
649
748
|
/**
|
|
749
|
+
* @public
|
|
650
750
|
* <p>Updates the content of a message.</p>
|
|
651
751
|
* <note>
|
|
652
752
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
653
|
-
*
|
|
753
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
654
754
|
* the header.</p>
|
|
655
755
|
* </note>
|
|
656
756
|
*/
|
|
@@ -658,10 +758,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
658
758
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
659
759
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
660
760
|
/**
|
|
761
|
+
* @public
|
|
661
762
|
* <p>The details of the time when a user last read messages in a channel.</p>
|
|
662
763
|
* <note>
|
|
663
764
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
664
|
-
*
|
|
765
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
665
766
|
* the header.</p>
|
|
666
767
|
* </note>
|
|
667
768
|
*/
|