Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Sends an event to a specific room which directs clients to delete a
specific message; that is, unrender it from view and delete it from the
client’s chat history. This event’s EventName
is aws:DELETE_MESSAGE
.
This replicates the
DeleteMessage
WebSocket operation in the Amazon IVS Chat Messaging API.
Synopsis
- data DeleteMessage = DeleteMessage' {}
- newDeleteMessage :: Text -> Text -> DeleteMessage
- deleteMessage_reason :: Lens' DeleteMessage (Maybe Text)
- deleteMessage_id :: Lens' DeleteMessage Text
- deleteMessage_roomIdentifier :: Lens' DeleteMessage Text
- data DeleteMessageResponse = DeleteMessageResponse' {
- id :: Maybe Text
- httpStatus :: Int
- newDeleteMessageResponse :: Int -> DeleteMessageResponse
- deleteMessageResponse_id :: Lens' DeleteMessageResponse (Maybe Text)
- deleteMessageResponse_httpStatus :: Lens' DeleteMessageResponse Int
Creating a Request
data DeleteMessage Source #
See: newDeleteMessage
smart constructor.
DeleteMessage' | |
|
Instances
Create a value of DeleteMessage
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:reason:DeleteMessage'
, deleteMessage_reason
- Reason for deleting the message.
DeleteMessage
, deleteMessage_id
- ID of the message to be deleted. This is the Id
field in the received
message (see
Message (Subscribe)
in the Chat Messaging API).
$sel:roomIdentifier:DeleteMessage'
, deleteMessage_roomIdentifier
- Identifier of the room where the message should be deleted. Currently
this must be an ARN.
Request Lenses
deleteMessage_reason :: Lens' DeleteMessage (Maybe Text) Source #
Reason for deleting the message.
deleteMessage_id :: Lens' DeleteMessage Text Source #
ID of the message to be deleted. This is the Id
field in the received
message (see
Message (Subscribe)
in the Chat Messaging API).
deleteMessage_roomIdentifier :: Lens' DeleteMessage Text Source #
Identifier of the room where the message should be deleted. Currently this must be an ARN.
Destructuring the Response
data DeleteMessageResponse Source #
See: newDeleteMessageResponse
smart constructor.
DeleteMessageResponse' | |
|
Instances
newDeleteMessageResponse Source #
Create a value of DeleteMessageResponse
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:
DeleteMessage
, deleteMessageResponse_id
- Operation identifier, generated by Amazon IVS Chat.
$sel:httpStatus:DeleteMessageResponse'
, deleteMessageResponse_httpStatus
- The response's http status code.
Response Lenses
deleteMessageResponse_id :: Lens' DeleteMessageResponse (Maybe Text) Source #
Operation identifier, generated by Amazon IVS Chat.
deleteMessageResponse_httpStatus :: Lens' DeleteMessageResponse Int Source #
The response's http status code.