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

Amazonka.IVSChat.SendEvent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Synopsis

data SendEvent = SendEvent' {
- attributes :: Maybe (HashMap Text Text)
- eventName :: Text
- roomIdentifier :: Text
}
newSendEvent :: Text -> Text -> SendEvent
sendEvent_attributes :: Lens' SendEvent (Maybe (HashMap Text Text))
sendEvent_eventName :: Lens' SendEvent Text
sendEvent_roomIdentifier :: Lens' SendEvent Text
data SendEventResponse = SendEventResponse' {
- id :: Maybe Text
- httpStatus :: Int
}
newSendEventResponse :: Int -> SendEventResponse
sendEventResponse_id :: Lens' SendEventResponse (Maybe Text)
sendEventResponse_httpStatus :: Lens' SendEventResponse Int

Creating a Request

data SendEvent Source #

See: newSendEvent smart constructor.

Constructors

SendEvent'
Fields attributes :: Maybe (HashMap Text Text) Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total. eventName :: Text Application-defined name of the event to send to clients. roomIdentifier :: Text Identifier of the room to which the event will be sent. Currently this must be an ARN.

Instances

Instances details

ToJSON SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods toJSON :: SendEvent -> Value # toEncoding :: SendEvent -> Encoding # toJSONList :: [SendEvent] -> Value # toEncodingList :: [SendEvent] -> Encoding #
ToHeaders SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods toHeaders :: SendEvent -> [Header] #
ToPath SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods toPath :: SendEvent -> ByteString #
ToQuery SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods toQuery :: SendEvent -> QueryString #
AWSRequest SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Associated Types type AWSResponse SendEvent # Methods request :: (Service -> Service) -> SendEvent -> Request SendEvent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendEvent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendEvent))) #
Generic SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Associated Types type Rep SendEvent :: Type -> Type # Methods from :: SendEvent -> Rep SendEvent x # to :: Rep SendEvent x -> SendEvent #
Read SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods readsPrec :: Int -> ReadS SendEvent # readList :: ReadS [SendEvent] # readPrec :: ReadPrec SendEvent # readListPrec :: ReadPrec [SendEvent] #
Show SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods showsPrec :: Int -> SendEvent -> ShowS # show :: SendEvent -> String # showList :: [SendEvent] -> ShowS #
NFData SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods rnf :: SendEvent -> () #
Eq SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods (==) :: SendEvent -> SendEvent -> Bool # (/=) :: SendEvent -> SendEvent -> Bool #
Hashable SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods hashWithSalt :: Int -> SendEvent -> Int # hash :: SendEvent -> Int #
type AWSResponse SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent type AWSResponse SendEvent = SendEventResponse
type Rep SendEvent Source #
Instance details Defined in Amazonka.IVSChat.SendEvent type Rep SendEvent = D1 ('MetaData "SendEvent" "Amazonka.IVSChat.SendEvent" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "SendEvent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "eventName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roomIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSendEvent Source #

Arguments

:: Text	`$sel:eventName:SendEvent'`
-> Text	`$sel:roomIdentifier:SendEvent'`
-> SendEvent

Create a value of SendEvent 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:attributes:SendEvent', sendEvent_attributes - Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

$sel:eventName:SendEvent', sendEvent_eventName - Application-defined name of the event to send to clients.

$sel:roomIdentifier:SendEvent', sendEvent_roomIdentifier - Identifier of the room to which the event will be sent. Currently this must be an ARN.

Request Lenses

sendEvent_attributes :: Lens' SendEvent (Maybe (HashMap Text Text)) Source #

Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

sendEvent_eventName :: Lens' SendEvent Text Source #

Application-defined name of the event to send to clients.

sendEvent_roomIdentifier :: Lens' SendEvent Text Source #

Identifier of the room to which the event will be sent. Currently this must be an ARN.

Destructuring the Response

data SendEventResponse Source #

See: newSendEventResponse smart constructor.

Constructors

SendEventResponse'
Fields id :: Maybe Text An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Associated Types type Rep SendEventResponse :: Type -> Type # Methods from :: SendEventResponse -> Rep SendEventResponse x # to :: Rep SendEventResponse x -> SendEventResponse #
Read SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods readsPrec :: Int -> ReadS SendEventResponse # readList :: ReadS [SendEventResponse] # readPrec :: ReadPrec SendEventResponse # readListPrec :: ReadPrec [SendEventResponse] #
Show SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods showsPrec :: Int -> SendEventResponse -> ShowS # show :: SendEventResponse -> String # showList :: [SendEventResponse] -> ShowS #
NFData SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods rnf :: SendEventResponse -> () #
Eq SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent Methods (==) :: SendEventResponse -> SendEventResponse -> Bool # (/=) :: SendEventResponse -> SendEventResponse -> Bool #
type Rep SendEventResponse Source #
Instance details Defined in Amazonka.IVSChat.SendEvent type Rep SendEventResponse = D1 ('MetaData "SendEventResponse" "Amazonka.IVSChat.SendEvent" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "SendEventResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendEventResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendEventResponse'`
-> SendEventResponse

Create a value of SendEventResponse 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:

SendEventResponse, sendEventResponse_id - An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.

$sel:httpStatus:SendEventResponse', sendEventResponse_httpStatus - The response's http status code.

Response Lenses

sendEventResponse_id :: Lens' SendEventResponse (Maybe Text) Source #

An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.

sendEventResponse_httpStatus :: Lens' SendEventResponse Int Source #

The response's http status code.