Amazonka.IVSChat.DeleteMessage

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.

Creating a Request

data DeleteMessage

See: newDeleteMessage smart constructor.

Constructors

DeleteMessage'

Fields

• reason :: Maybe Text

  Reason for deleting the message.

• id :: Text

  ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

• roomIdentifier :: Text

  Identifier of the room where the message should be deleted. Currently this must be an ARN.

Instances

ToJSON DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

toJSON :: DeleteMessage -> Value

toEncoding :: DeleteMessage -> Encoding

toJSONList :: [DeleteMessage] -> Value

toEncodingList :: [DeleteMessage] -> Encoding

ToHeaders DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

toHeaders :: DeleteMessage -> [Header]

ToPath DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

toPath :: DeleteMessage -> ByteString

ToQuery DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

toQuery :: DeleteMessage -> QueryString

AWSRequest DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Associated Types

type AWSResponse DeleteMessage

Methods

request :: (Service -> Service) -> DeleteMessage -> Request DeleteMessage

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteMessage)))

Generic DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Associated Types

type Rep DeleteMessage :: Type -> Type

Methods

from :: DeleteMessage -> Rep DeleteMessage x

to :: Rep DeleteMessage x -> DeleteMessage

Read DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

readsPrec :: Int -> ReadS DeleteMessage

readList :: ReadS [DeleteMessage]

readPrec :: ReadPrec DeleteMessage

readListPrec :: ReadPrec [DeleteMessage]

Show DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

showsPrec :: Int -> DeleteMessage -> ShowS

show :: DeleteMessage -> String

showList :: [DeleteMessage] -> ShowS

NFData DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

rnf :: DeleteMessage -> ()

Eq DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

(==) :: DeleteMessage -> DeleteMessage -> Bool

(/=) :: DeleteMessage -> DeleteMessage -> Bool

Hashable DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

Methods

hashWithSalt :: Int -> DeleteMessage -> Int

hash :: DeleteMessage -> Int

type AWSResponse DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

type AWSResponse DeleteMessage = DeleteMessageResponse

type Rep DeleteMessage

Defined in Amazonka.IVSChat.DeleteMessage

type Rep DeleteMessage = D1 ('MetaData "DeleteMessage" "Amazonka.IVSChat.DeleteMessage" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "DeleteMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roomIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteMessage

Arguments

:: Text

DeleteMessage

-> Text

$sel:roomIdentifier:DeleteMessage'

-> DeleteMessage

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)

Reason for deleting the message.

deleteMessage_id :: Lens' DeleteMessage Text

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

Identifier of the room where the message should be deleted. Currently this must be an ARN.

Destructuring the Response

data DeleteMessageResponse

See: newDeleteMessageResponse smart constructor.

Constructors

DeleteMessageResponse'

Fields

• id :: Maybe Text

  Operation identifier, generated by Amazon IVS Chat.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

Associated Types

type Rep DeleteMessageResponse :: Type -> Type

Methods

from :: DeleteMessageResponse -> Rep DeleteMessageResponse x

to :: Rep DeleteMessageResponse x -> DeleteMessageResponse

Read DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

Methods

readsPrec :: Int -> ReadS DeleteMessageResponse

readList :: ReadS [DeleteMessageResponse]

readPrec :: ReadPrec DeleteMessageResponse

readListPrec :: ReadPrec [DeleteMessageResponse]

Show DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

Methods

showsPrec :: Int -> DeleteMessageResponse -> ShowS

show :: DeleteMessageResponse -> String

showList :: [DeleteMessageResponse] -> ShowS

NFData DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

Methods

rnf :: DeleteMessageResponse -> ()

Eq DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

Methods

(==) :: DeleteMessageResponse -> DeleteMessageResponse -> Bool

(/=) :: DeleteMessageResponse -> DeleteMessageResponse -> Bool

type Rep DeleteMessageResponse

Defined in Amazonka.IVSChat.DeleteMessage

type Rep DeleteMessageResponse = D1 ('MetaData "DeleteMessageResponse" "Amazonka.IVSChat.DeleteMessage" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "DeleteMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteMessageResponse

Arguments

:: Int

$sel:httpStatus:DeleteMessageResponse'

-> DeleteMessageResponse

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)

Operation identifier, generated by Amazon IVS Chat.

deleteMessageResponse_httpStatus :: Lens' DeleteMessageResponse Int

The response's http status code.