| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ChimeSDKMessaging.SendChannelMessage
Description
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the
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.
Synopsis
- data SendChannelMessage = SendChannelMessage' {}
- newSendChannelMessage :: Text -> Text -> ChannelMessageType -> ChannelMessagePersistenceType -> Text -> Text -> SendChannelMessage
- sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text)
- sendChannelMessage_channelArn :: Lens' SendChannelMessage Text
- sendChannelMessage_content :: Lens' SendChannelMessage Text
- sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType
- sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType
- sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text
- sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text
- data SendChannelMessageResponse = SendChannelMessageResponse' {}
- newSendChannelMessageResponse :: Int -> SendChannelMessageResponse
- sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure)
- sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text)
- sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text)
- sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int
Creating a Request
data SendChannelMessage Source #
See: newSendChannelMessage smart constructor.
Constructors
| SendChannelMessage' | |
Fields
| |
Instances
newSendChannelMessage Source #
Arguments
| :: Text | |
| -> Text | |
| -> ChannelMessageType | |
| -> ChannelMessagePersistenceType | |
| -> Text | |
| -> Text | |
| -> SendChannelMessage |
Create a value of SendChannelMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metadata:SendChannelMessage', sendChannelMessage_metadata - The optional metadata for each message.
$sel:channelArn:SendChannelMessage', sendChannelMessage_channelArn - The ARN of the channel.
$sel:content:SendChannelMessage', sendChannelMessage_content - The content of the message.
$sel:type':SendChannelMessage', sendChannelMessage_type - The type of message, STANDARD or CONTROL.
$sel:persistence:SendChannelMessage', sendChannelMessage_persistence - Boolean that controls whether the message is persisted on the back end.
Required.
$sel:clientRequestToken:SendChannelMessage', sendChannelMessage_clientRequestToken - The Idempotency token for each client request.
$sel:chimeBearer:SendChannelMessage', sendChannelMessage_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text) Source #
The optional metadata for each message.
sendChannelMessage_channelArn :: Lens' SendChannelMessage Text Source #
The ARN of the channel.
sendChannelMessage_content :: Lens' SendChannelMessage Text Source #
The content of the message.
sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType Source #
The type of message, STANDARD or CONTROL.
sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType Source #
Boolean that controls whether the message is persisted on the back end. Required.
sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text Source #
The Idempotency token for each client request.
sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data SendChannelMessageResponse Source #
See: newSendChannelMessageResponse smart constructor.
Constructors
| SendChannelMessageResponse' | |
Fields
| |
Instances
newSendChannelMessageResponse Source #
Create a value of SendChannelMessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:SendChannelMessageResponse', sendChannelMessageResponse_status - The status of the channel message.
$sel:channelArn:SendChannelMessage', sendChannelMessageResponse_channelArn - The ARN of the channel.
$sel:messageId:SendChannelMessageResponse', sendChannelMessageResponse_messageId - The ID string assigned to each message.
$sel:httpStatus:SendChannelMessageResponse', sendChannelMessageResponse_httpStatus - The response's http status code.
Response Lenses
sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure) Source #
The status of the channel message.
sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text) Source #
The ARN of the channel.
sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text) Source #
The ID string assigned to each message.
sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int Source #
The response's http status code.