@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonChimeSDKMessaging extends Object implements AmazonChimeSDKMessaging
AmazonChimeSDKMessaging. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
AmazonChimeSDKMessagingAdds a specified number of users to a channel.
batchCreateChannelMembership in interface AmazonChimeSDKMessagingpublic CreateChannelResult createChannel(CreateChannelRequest request)
AmazonChimeSDKMessagingCreates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannel in interface AmazonChimeSDKMessagingpublic CreateChannelBanResult createChannelBan(CreateChannelBanRequest request)
AmazonChimeSDKMessaging
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up
when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelBan in interface AmazonChimeSDKMessagingpublic CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)
AmazonChimeSDKMessaging
Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel
member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelMembership in interface AmazonChimeSDKMessagingpublic CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest request)
AmazonChimeSDKMessaging
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelModerator in interface AmazonChimeSDKMessagingpublic DeleteChannelResult deleteChannel(DeleteChannelRequest request)
AmazonChimeSDKMessagingImmediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannel in interface AmazonChimeSDKMessagingpublic DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest request)
AmazonChimeSDKMessagingRemoves a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelBan in interface AmazonChimeSDKMessagingpublic DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest request)
AmazonChimeSDKMessagingRemoves a member from a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMembership in interface AmazonChimeSDKMessagingpublic DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest request)
AmazonChimeSDKMessaging
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMessage in interface AmazonChimeSDKMessagingpublic DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest request)
AmazonChimeSDKMessagingDeletes a channel moderator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelModerator in interface AmazonChimeSDKMessagingpublic DescribeChannelResult describeChannel(DescribeChannelRequest request)
AmazonChimeSDKMessaging
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannel in interface AmazonChimeSDKMessagingpublic DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest request)
AmazonChimeSDKMessagingReturns the full details of a channel ban.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelBan in interface AmazonChimeSDKMessagingpublic DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest request)
AmazonChimeSDKMessagingReturns the full details of a user's channel membership.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembership in interface AmazonChimeSDKMessagingpublic DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
AmazonChimeSDKMessaging
Returns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembershipForAppInstanceUser in interface AmazonChimeSDKMessagingpublic DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
AmazonChimeSDKMessaging
Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModeratedByAppInstanceUser in interface AmazonChimeSDKMessagingpublic DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest request)
AmazonChimeSDKMessagingReturns the full details of a single ChannelModerator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModerator in interface AmazonChimeSDKMessagingpublic GetChannelMessageResult getChannelMessage(GetChannelMessageRequest request)
AmazonChimeSDKMessagingGets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that
makes the API call as the value in the header.
getChannelMessage in interface AmazonChimeSDKMessagingpublic GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
AmazonChimeSDKMessagingThe details of the endpoint for the messaging session.
getMessagingSessionEndpoint in interface AmazonChimeSDKMessagingpublic ListChannelBansResult listChannelBans(ListChannelBansRequest request)
AmazonChimeSDKMessagingLists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelBans in interface AmazonChimeSDKMessagingpublic ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)
AmazonChimeSDKMessagingLists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMemberships in interface AmazonChimeSDKMessagingpublic ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
AmazonChimeSDKMessaging
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUser in interface AmazonChimeSDKMessagingpublic ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest request)
AmazonChimeSDKMessaging
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
listChannelMessages in interface AmazonChimeSDKMessagingpublic ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest request)
AmazonChimeSDKMessagingLists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelModerators in interface AmazonChimeSDKMessagingpublic ListChannelsResult listChannels(ListChannelsRequest request)
AmazonChimeSDKMessagingLists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an
account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannels in interface AmazonChimeSDKMessagingpublic ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
AmazonChimeSDKMessaging
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsModeratedByAppInstanceUser in interface AmazonChimeSDKMessagingpublic RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest request)
AmazonChimeSDKMessagingRedacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
redactChannelMessage in interface AmazonChimeSDKMessagingpublic SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest request)
AmazonChimeSDKMessagingSends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessage in interface AmazonChimeSDKMessagingpublic UpdateChannelResult updateChannel(UpdateChannelRequest request)
AmazonChimeSDKMessagingUpdate a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannel in interface AmazonChimeSDKMessagingpublic UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)
AmazonChimeSDKMessagingUpdates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelMessage in interface AmazonChimeSDKMessagingpublic UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
AmazonChimeSDKMessagingThe details of the time when a user last read messages in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelReadMarker in interface AmazonChimeSDKMessagingpublic void shutdown()
AmazonChimeSDKMessagingshutdown in interface AmazonChimeSDKMessagingpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonChimeSDKMessagingResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonChimeSDKMessagingrequest - The originally executed request.