ChannelChatMessageMessage
The message received by the ChannelChatMessage event.
Extends
BaseSubscriptionMessage<SubscriptionTypes.ChannelChatMessage,K>
Type parameters
| Type parameter |
|---|
K extends ConnectionTypes |
Constructors
new ChannelChatMessageMessage()
1new ChannelChatMessageMessage<K>(2 connection: K,3 subscription: SubscriptionType<ChannelChatMessage, K>,4data: ChannelChatMessageEvent): ChannelChatMessageMessage<K>Builds up a ChannelChatMessage message.
Parameters
| Parameter | Type | Description |
|---|---|---|
connection | K | The EventSub connection used. |
subscription | SubscriptionType<ChannelChatMessage, K> | The subscription which trigger this message. |
data | ChannelChatMessageEvent | The event data received with the subscription. |
Returns
Overrides
BaseSubscriptionMessage.constructor
Source
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
broadcaster | readonly | BaseUser<ChannelChatMessage, K> | The broadcaster of the channel where the chat message was sent. | - |
chatter | readonly | ChannelChatMessageChatter<K> | The chatter who sent the message. | - |
connection | readonly | K | The EventSub connection used. | BaseSubscriptionMessage.connection |
message | readonly | BaseMessage<ChannelChatMessage, K> | The message which was sent. | - |
subscription | readonly | SubscriptionType<ChannelChatMessage, K> | The subscription which trigger this message. | BaseSubscriptionMessage.subscription |
Methods
checkMessageType()
1checkMessageType<U>(type: U): this is SubscriptionMessages<K>[U]Checks whether the message is of a certain type.
Type parameters
| Type parameter | Value |
|---|---|
U extends SubscriptionTypes | SubscriptionTypes |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | U | The type to check. |
Returns
this is SubscriptionMessages<K>[U]
Whether the message is of the type.
Inherited from
BaseSubscriptionMessage.checkMessageType
Source
twitchfy/packages/eventsub/src/structures/messages/BaseSubscriptionMessage.ts:24