@aws-sdk/client-chime-sdk-messaging 3.295.0 → 3.297.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 +24 -0
- package/dist-cjs/ChimeSDKMessaging.js +45 -0
- package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +46 -0
- package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +46 -0
- package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +32 -3
- package/dist-cjs/protocols/Aws_restJson1.js +243 -2
- package/dist-es/ChimeSDKMessaging.js +45 -0
- package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +42 -0
- package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +42 -0
- package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +235 -0
- package/dist-types/ChimeSDKMessaging.d.ts +76 -40
- package/dist-types/ChimeSDKMessagingClient.d.ts +29 -6
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -1
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +16 -2
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +17 -3
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -4
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -2
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -1
- package/dist-types/commands/DeleteChannelCommand.d.ts +16 -1
- package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -1
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -1
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -1
- package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +76 -0
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -2
- package/dist-types/commands/DescribeChannelCommand.d.ts +16 -2
- package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -1
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -1
- package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -1
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -3
- package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
- package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +82 -0
- package/dist-types/commands/ListChannelBansCommand.d.ts +16 -1
- package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -2
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -1
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +16 -2
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -1
- package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +86 -0
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -1
- package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
- package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -2
- 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 +16 -0
- package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -1
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +430 -0
- 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 +9 -0
- package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +69 -0
- package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +42 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +29 -29
|
@@ -14,6 +14,7 @@ import { DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput } from ".
|
|
|
14
14
|
import { DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput } from "./commands/DeleteChannelMembershipCommand";
|
|
15
15
|
import { DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput } from "./commands/DeleteChannelMessageCommand";
|
|
16
16
|
import { DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput } from "./commands/DeleteChannelModeratorCommand";
|
|
17
|
+
import { DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput } from "./commands/DeleteMessagingStreamingConfigurationsCommand";
|
|
17
18
|
import { DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput } from "./commands/DescribeChannelBanCommand";
|
|
18
19
|
import { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
|
|
19
20
|
import { DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput } from "./commands/DescribeChannelFlowCommand";
|
|
@@ -26,6 +27,7 @@ import { GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPrefer
|
|
|
26
27
|
import { GetChannelMessageCommandInput, GetChannelMessageCommandOutput } from "./commands/GetChannelMessageCommand";
|
|
27
28
|
import { GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput } from "./commands/GetChannelMessageStatusCommand";
|
|
28
29
|
import { GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput } from "./commands/GetMessagingSessionEndpointCommand";
|
|
30
|
+
import { GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput } from "./commands/GetMessagingStreamingConfigurationsCommand";
|
|
29
31
|
import { ListChannelBansCommandInput, ListChannelBansCommandOutput } from "./commands/ListChannelBansCommand";
|
|
30
32
|
import { ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput } from "./commands/ListChannelFlowsCommand";
|
|
31
33
|
import { ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput } from "./commands/ListChannelMembershipsCommand";
|
|
@@ -38,6 +40,7 @@ import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModerat
|
|
|
38
40
|
import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
|
|
39
41
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
40
42
|
import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
|
|
43
|
+
import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
|
|
41
44
|
import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
|
|
42
45
|
import { SearchChannelsCommandInput, SearchChannelsCommandOutput } from "./commands/SearchChannelsCommand";
|
|
43
46
|
import { SendChannelMessageCommandInput, SendChannelMessageCommandOutput } from "./commands/SendChannelMessageCommand";
|
|
@@ -48,6 +51,7 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
|
|
|
48
51
|
import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
|
|
49
52
|
import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
|
|
50
53
|
/**
|
|
54
|
+
* @public
|
|
51
55
|
* <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
|
|
52
56
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
53
57
|
* provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
|
|
@@ -55,9 +59,9 @@ import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutp
|
|
|
55
59
|
*/
|
|
56
60
|
export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
57
61
|
/**
|
|
62
|
+
* @public
|
|
58
63
|
* <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
|
|
59
64
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
60
|
-
*
|
|
61
65
|
* <note>
|
|
62
66
|
* <p>Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code>
|
|
63
67
|
* of the user that makes the API call as the value in the header.</p>
|
|
@@ -67,12 +71,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
67
71
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
68
72
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
69
73
|
/**
|
|
74
|
+
* @public
|
|
70
75
|
* <p>Adds a specified number of users to a channel. </p>
|
|
71
76
|
*/
|
|
72
77
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateChannelMembershipCommandOutput>;
|
|
73
78
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
74
79
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
75
80
|
/**
|
|
81
|
+
* @public
|
|
76
82
|
* <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>
|
|
77
83
|
* <p>You can return one of the following processing responses:</p>
|
|
78
84
|
* <ul>
|
|
@@ -91,12 +97,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
91
97
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
92
98
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
93
99
|
/**
|
|
100
|
+
* @public
|
|
94
101
|
* <p>Creates a channel to which you can add users and send messages.</p>
|
|
95
|
-
*
|
|
96
102
|
* <p>
|
|
97
103
|
* <b>Restriction</b>: You can't change a channel's
|
|
98
104
|
* privacy.</p>
|
|
99
|
-
*
|
|
100
105
|
* <note>
|
|
101
106
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
102
107
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -107,13 +112,13 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
107
112
|
createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
108
113
|
createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
109
114
|
/**
|
|
115
|
+
* @public
|
|
110
116
|
* <p>Permanently bans a member from a channel. Moderators can't add banned members to a
|
|
111
117
|
* channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
|
|
112
118
|
* <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
|
|
113
119
|
* channels.</p>
|
|
114
120
|
* <p>If you ban a user who is already part of a channel, that user is automatically kicked
|
|
115
121
|
* from the channel.</p>
|
|
116
|
-
*
|
|
117
122
|
* <note>
|
|
118
123
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
119
124
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -124,12 +129,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
124
129
|
createChannelBan(args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
125
130
|
createChannelBan(args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
126
131
|
/**
|
|
132
|
+
* @public
|
|
127
133
|
* <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
|
|
128
134
|
* that perform actions on chat messages, such as stripping out profanity. You can associate
|
|
129
135
|
* channel flows with channels, and the processors in the channel flow then take action on all
|
|
130
136
|
* messages sent to that channel. This is a developer API.</p>
|
|
131
|
-
*
|
|
132
|
-
* <p>Channel flows process the following items:</p>
|
|
137
|
+
* <p>Channel flows process the following items:</p>
|
|
133
138
|
* <ol>
|
|
134
139
|
* <li>
|
|
135
140
|
* <p>New and updated messages</p>
|
|
@@ -141,7 +146,6 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
141
146
|
* <p>The Standard message type</p>
|
|
142
147
|
* </li>
|
|
143
148
|
* </ol>
|
|
144
|
-
*
|
|
145
149
|
* <note>
|
|
146
150
|
* <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to
|
|
147
151
|
* <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
|
|
@@ -151,9 +155,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
151
155
|
createChannelFlow(args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
152
156
|
createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
153
157
|
/**
|
|
158
|
+
* @public
|
|
154
159
|
* <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
|
|
155
160
|
* request header. A channel member can:</p>
|
|
156
|
-
*
|
|
157
161
|
* <ul>
|
|
158
162
|
* <li>
|
|
159
163
|
* <p>List messages</p>
|
|
@@ -171,9 +175,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
171
175
|
* <p>Leave the channel</p>
|
|
172
176
|
* </li>
|
|
173
177
|
* </ul>
|
|
174
|
-
*
|
|
175
178
|
* <p>Privacy settings impact this action as follows:</p>
|
|
176
|
-
*
|
|
177
179
|
* <ul>
|
|
178
180
|
* <li>
|
|
179
181
|
* <p>Public Channels: You do not need to be a member to list messages, but you must be
|
|
@@ -183,7 +185,6 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
183
185
|
* <p>Private Channels: You must be a member to list or send messages.</p>
|
|
184
186
|
* </li>
|
|
185
187
|
* </ul>
|
|
186
|
-
*
|
|
187
188
|
* <note>
|
|
188
189
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
189
190
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -194,8 +195,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
194
195
|
createChannelMembership(args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
195
196
|
createChannelMembership(args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
196
197
|
/**
|
|
198
|
+
* @public
|
|
197
199
|
* <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
|
|
198
|
-
*
|
|
199
200
|
* <ul>
|
|
200
201
|
* <li>
|
|
201
202
|
* <p>Add and remove other members of the channel.</p>
|
|
@@ -213,7 +214,6 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
213
214
|
* <p>List messages in the channel.</p>
|
|
214
215
|
* </li>
|
|
215
216
|
* </ul>
|
|
216
|
-
*
|
|
217
217
|
* <note>
|
|
218
218
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
219
219
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -224,9 +224,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
224
224
|
createChannelModerator(args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
225
225
|
createChannelModerator(args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
226
226
|
/**
|
|
227
|
+
* @public
|
|
227
228
|
* <p>Immediately makes a channel and its memberships inaccessible and marks them for
|
|
228
229
|
* deletion. This is an irreversible process.</p>
|
|
229
|
-
*
|
|
230
230
|
* <note>
|
|
231
231
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
232
232
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -237,8 +237,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
237
237
|
deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
238
238
|
deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
239
239
|
/**
|
|
240
|
+
* @public
|
|
240
241
|
* <p>Removes a user from a channel's ban list.</p>
|
|
241
|
-
*
|
|
242
242
|
* <note>
|
|
243
243
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
244
244
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -249,6 +249,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
249
249
|
deleteChannelBan(args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
250
250
|
deleteChannelBan(args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
251
251
|
/**
|
|
252
|
+
* @public
|
|
252
253
|
* <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
|
|
253
254
|
* <note>
|
|
254
255
|
* <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
|
|
@@ -259,8 +260,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
259
260
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
260
261
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
261
262
|
/**
|
|
263
|
+
* @public
|
|
262
264
|
* <p>Removes a member from a channel.</p>
|
|
263
|
-
*
|
|
264
265
|
* <note>
|
|
265
266
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
266
267
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -271,10 +272,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
271
272
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
272
273
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
273
274
|
/**
|
|
275
|
+
* @public
|
|
274
276
|
* <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
|
|
275
277
|
* inaccessible immediately. A background process deletes any revisions created by
|
|
276
278
|
* <code>UpdateChannelMessage</code>.</p>
|
|
277
|
-
*
|
|
278
279
|
* <note>
|
|
279
280
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
280
281
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -285,8 +286,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
285
286
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
286
287
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
287
288
|
/**
|
|
289
|
+
* @public
|
|
288
290
|
* <p>Deletes a channel moderator.</p>
|
|
289
|
-
*
|
|
290
291
|
* <note>
|
|
291
292
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
292
293
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -297,11 +298,18 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
297
298
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
298
299
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
299
300
|
/**
|
|
301
|
+
* @public
|
|
302
|
+
* <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
|
|
303
|
+
* <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>
|
|
304
|
+
*/
|
|
305
|
+
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMessagingStreamingConfigurationsCommandOutput>;
|
|
306
|
+
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
307
|
+
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
300
310
|
* <p>Returns the full details of a channel in an Amazon Chime
|
|
301
311
|
* <code>AppInstance</code>.</p>
|
|
302
|
-
*
|
|
303
312
|
* <note>
|
|
304
|
-
*
|
|
305
313
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
306
314
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
307
315
|
* the header.</p>
|
|
@@ -311,10 +319,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
311
319
|
describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
312
320
|
describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
313
321
|
/**
|
|
322
|
+
* @public
|
|
314
323
|
* <p>Returns the full details of a channel ban.</p>
|
|
315
|
-
*
|
|
316
324
|
* <note>
|
|
317
|
-
*
|
|
318
325
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
319
326
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
320
327
|
* the header.</p>
|
|
@@ -324,12 +331,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
324
331
|
describeChannelBan(args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
325
332
|
describeChannelBan(args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
326
333
|
/**
|
|
334
|
+
* @public
|
|
327
335
|
* <p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</p>
|
|
328
336
|
*/
|
|
329
337
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelFlowCommandOutput>;
|
|
330
338
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
331
339
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
332
340
|
/**
|
|
341
|
+
* @public
|
|
333
342
|
* <p>Returns the full details of a user's channel membership.</p>
|
|
334
343
|
* <note>
|
|
335
344
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -341,9 +350,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
341
350
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
342
351
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
343
352
|
/**
|
|
353
|
+
* @public
|
|
344
354
|
* <p> Returns the details of a channel based on the membership of the specified
|
|
345
355
|
* <code>AppInstanceUser</code>.</p>
|
|
346
|
-
*
|
|
347
356
|
* <note>
|
|
348
357
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
349
358
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -354,9 +363,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
354
363
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
355
364
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
356
365
|
/**
|
|
366
|
+
* @public
|
|
357
367
|
* <p>Returns the full details of a channel moderated by the specified
|
|
358
368
|
* <code>AppInstanceUser</code>.</p>
|
|
359
|
-
*
|
|
360
369
|
* <note>
|
|
361
370
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
362
371
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -367,6 +376,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
367
376
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
368
377
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
369
378
|
/**
|
|
379
|
+
* @public
|
|
370
380
|
* <p>Returns the full details of a single ChannelModerator.</p>
|
|
371
381
|
* <note>
|
|
372
382
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -378,6 +388,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
378
388
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
379
389
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
380
390
|
/**
|
|
391
|
+
* @public
|
|
381
392
|
* <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
|
|
382
393
|
* that channel stop going through the channel flow processor.</p>
|
|
383
394
|
* <note>
|
|
@@ -389,6 +400,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
389
400
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
390
401
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
391
402
|
/**
|
|
403
|
+
* @public
|
|
392
404
|
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
|
|
393
405
|
* Only the <code>AppInstanceUser</code> who owns the membership can retrieve preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't retrieve preferences for other users.
|
|
394
406
|
* Banned users can't retrieve membership preferences for the channel from which they are banned.</p>
|
|
@@ -397,8 +409,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
397
409
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
398
410
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
399
411
|
/**
|
|
412
|
+
* @public
|
|
400
413
|
* <p>Gets the full details of a channel message.</p>
|
|
401
|
-
*
|
|
402
414
|
* <note>
|
|
403
415
|
* <p>The x-amz-chime-bearer request header is mandatory. Use the
|
|
404
416
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -409,11 +421,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
409
421
|
getChannelMessage(args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
410
422
|
getChannelMessage(args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
411
423
|
/**
|
|
424
|
+
* @public
|
|
412
425
|
* <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
|
|
413
426
|
* retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
|
|
414
|
-
*
|
|
415
427
|
* <p>Messages can have any one of these statuses.</p>
|
|
416
|
-
*
|
|
417
428
|
* <dl>
|
|
418
429
|
* <dt>SENT</dt>
|
|
419
430
|
* <dd>
|
|
@@ -432,7 +443,6 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
432
443
|
* <p>Messasge denied by the processor</p>
|
|
433
444
|
* </dd>
|
|
434
445
|
* </dl>
|
|
435
|
-
*
|
|
436
446
|
* <note>
|
|
437
447
|
* <ul>
|
|
438
448
|
* <li>
|
|
@@ -451,14 +461,23 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
451
461
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
452
462
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
453
463
|
/**
|
|
464
|
+
* @public
|
|
454
465
|
* <p>The details of the endpoint for the messaging session.</p>
|
|
455
466
|
*/
|
|
456
467
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingSessionEndpointCommandOutput>;
|
|
457
468
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
458
469
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
459
470
|
/**
|
|
471
|
+
* @public
|
|
472
|
+
* <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
473
|
+
* <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>
|
|
474
|
+
*/
|
|
475
|
+
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingStreamingConfigurationsCommandOutput>;
|
|
476
|
+
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
477
|
+
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
460
480
|
* <p>Lists all the users banned from a particular channel.</p>
|
|
461
|
-
*
|
|
462
481
|
* <note>
|
|
463
482
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
464
483
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -469,20 +488,20 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
469
488
|
listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
470
489
|
listChannelBans(args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
471
490
|
/**
|
|
491
|
+
* @public
|
|
472
492
|
* <p>Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.</p>
|
|
473
493
|
*/
|
|
474
494
|
listChannelFlows(args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelFlowsCommandOutput>;
|
|
475
495
|
listChannelFlows(args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
476
496
|
listChannelFlows(args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
477
497
|
/**
|
|
498
|
+
* @public
|
|
478
499
|
* <p>Lists all channel memberships in a channel.</p>
|
|
479
|
-
*
|
|
480
500
|
* <note>
|
|
481
501
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
482
502
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
483
503
|
* the header.</p>
|
|
484
504
|
* </note>
|
|
485
|
-
*
|
|
486
505
|
* <p>If you want to list the channels to which a specific app instance user belongs, see the
|
|
487
506
|
* <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
|
|
488
507
|
*/
|
|
@@ -490,9 +509,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
490
509
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
491
510
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
492
511
|
/**
|
|
512
|
+
* @public
|
|
493
513
|
* <p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an
|
|
494
514
|
* <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
|
|
495
|
-
*
|
|
496
515
|
* <note>
|
|
497
516
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
498
517
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -503,6 +522,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
503
522
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
504
523
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
505
524
|
/**
|
|
525
|
+
* @public
|
|
506
526
|
* <p>List all the messages in a channel. Returns a paginated list of
|
|
507
527
|
* <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending
|
|
508
528
|
* order.</p>
|
|
@@ -519,6 +539,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
519
539
|
listChannelMessages(args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
520
540
|
listChannelMessages(args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
521
541
|
/**
|
|
542
|
+
* @public
|
|
522
543
|
* <p>Lists all the moderators for a channel.</p>
|
|
523
544
|
* <note>
|
|
524
545
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -530,9 +551,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
530
551
|
listChannelModerators(args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
531
552
|
listChannelModerators(args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
532
553
|
/**
|
|
554
|
+
* @public
|
|
533
555
|
* <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
|
|
534
556
|
* filters to narrow results.</p>
|
|
535
|
-
*
|
|
536
557
|
* <p class="title">
|
|
537
558
|
* <b>Functionality & restrictions</b>
|
|
538
559
|
* </p>
|
|
@@ -546,7 +567,6 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
546
567
|
* list the private channels in an account.</p>
|
|
547
568
|
* </li>
|
|
548
569
|
* </ul>
|
|
549
|
-
*
|
|
550
570
|
* <note>
|
|
551
571
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
552
572
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -557,14 +577,15 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
557
577
|
listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
558
578
|
listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
559
579
|
/**
|
|
580
|
+
* @public
|
|
560
581
|
* <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>
|
|
561
582
|
*/
|
|
562
583
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsAssociatedWithChannelFlowCommandOutput>;
|
|
563
584
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
564
585
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
565
586
|
/**
|
|
587
|
+
* @public
|
|
566
588
|
* <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
|
|
567
|
-
*
|
|
568
589
|
* <note>
|
|
569
590
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
570
591
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -575,18 +596,21 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
575
596
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
576
597
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
577
598
|
/**
|
|
599
|
+
* @public
|
|
578
600
|
* <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>
|
|
579
601
|
*/
|
|
580
602
|
listSubChannels(args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubChannelsCommandOutput>;
|
|
581
603
|
listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
582
604
|
listSubChannels(args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
583
605
|
/**
|
|
606
|
+
* @public
|
|
584
607
|
* <p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>
|
|
585
608
|
*/
|
|
586
609
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
587
610
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
588
611
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
589
612
|
/**
|
|
613
|
+
* @public
|
|
590
614
|
* <p>Sets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
|
|
591
615
|
* Only the <code>AppInstanceUser</code> who owns the membership can set preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users.
|
|
592
616
|
* Banned users can't set membership preferences for the channel from which they are banned.</p>
|
|
@@ -595,9 +619,17 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
595
619
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
596
620
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
597
621
|
/**
|
|
622
|
+
* @public
|
|
623
|
+
* <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
624
|
+
* <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>
|
|
625
|
+
*/
|
|
626
|
+
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<PutMessagingStreamingConfigurationsCommandOutput>;
|
|
627
|
+
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
628
|
+
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
629
|
+
/**
|
|
630
|
+
* @public
|
|
598
631
|
* <p>Redacts message content, but not metadata. The message exists in the back end, but the
|
|
599
632
|
* action returns null content, and the state shows as redacted.</p>
|
|
600
|
-
*
|
|
601
633
|
* <note>
|
|
602
634
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
603
635
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -608,19 +640,19 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
608
640
|
redactChannelMessage(args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
609
641
|
redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
610
642
|
/**
|
|
643
|
+
* @public
|
|
611
644
|
* <p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>
|
|
612
645
|
*/
|
|
613
646
|
searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
|
|
614
647
|
searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
615
648
|
searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
616
649
|
/**
|
|
650
|
+
* @public
|
|
617
651
|
* <p>Sends a message to a particular channel that the member is a part of.</p>
|
|
618
|
-
*
|
|
619
652
|
* <note>
|
|
620
653
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
621
654
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
622
655
|
* the header.</p>
|
|
623
|
-
*
|
|
624
656
|
* <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
|
|
625
657
|
* <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
|
|
626
658
|
* </note>
|
|
@@ -629,18 +661,21 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
629
661
|
sendChannelMessage(args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
630
662
|
sendChannelMessage(args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
631
663
|
/**
|
|
664
|
+
* @public
|
|
632
665
|
* <p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>
|
|
633
666
|
*/
|
|
634
667
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
635
668
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
636
669
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
637
670
|
/**
|
|
671
|
+
* @public
|
|
638
672
|
* <p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>
|
|
639
673
|
*/
|
|
640
674
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
641
675
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
642
676
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
643
677
|
/**
|
|
678
|
+
* @public
|
|
644
679
|
* <p>Update a channel's attributes.</p>
|
|
645
680
|
* <p>
|
|
646
681
|
* <b>Restriction</b>: You can't change a channel's privacy. </p>
|
|
@@ -654,14 +689,15 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
654
689
|
updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
655
690
|
updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
656
691
|
/**
|
|
692
|
+
* @public
|
|
657
693
|
* <p>Updates channel flow attributes. This is a developer API.</p>
|
|
658
694
|
*/
|
|
659
695
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelFlowCommandOutput>;
|
|
660
696
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
661
697
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
662
698
|
/**
|
|
699
|
+
* @public
|
|
663
700
|
* <p>Updates the content of a message.</p>
|
|
664
|
-
*
|
|
665
701
|
* <note>
|
|
666
702
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
667
703
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -672,8 +708,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
672
708
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
673
709
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
674
710
|
/**
|
|
711
|
+
* @public
|
|
675
712
|
* <p>The details of the time when a user last read messages in a channel.</p>
|
|
676
|
-
*
|
|
677
713
|
* <note>
|
|
678
714
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
679
715
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|