ChannelUpdateMessage

The message received by the ChannelUpdate event.

Extends

• BaseSubscriptionMessage<SubscriptionTypes.ChannelUpdate, K>

Type parameters

Type parameter	Value
K extends ConnectionTypes	ConnectionTypes

Constructors

new ChannelUpdateMessage()

new ChannelUpdateMessage<K>(
   connection: K,
   subscription: SubscriptionType<ChannelUpdate, K>,
data: ChannelUpdateEvent): ChannelUpdateMessage<K>

Builds up a ChannelUpdate message.

Parameters

Parameter	Type	Description
connection	K	The EventSub connection used.
subscription	SubscriptionType<ChannelUpdate, K>	The subscription which trigger this message.
data	ChannelUpdateEvent	The event data received with the subscription.

Returns

ChannelUpdateMessage<K>

Overrides

BaseSubscriptionMessage.constructor

Source

twitchfy/packages/eventsub/src/structures/messages/ChannelUpdate/ChannelUpdateMessage.ts:45

Properties

Property	Modifier	Type	Description	Inherited from
broadcaster	readonly	BaseUser<ChannelUpdate, K>	The broadcaster of the channel which was updated.	-
category	readonly	ChannelUpdateCategory<K>	The category of the channel after it was updated.	-
connection	readonly	K	The EventSub connection used.	BaseSubscriptionMessage.connection
labels	readonly	string[]	The content classification labels of the channel after it was updated.	-
language	readonly	string	The language of the channel after it was updated.	-
subscription	readonly	SubscriptionType<ChannelUpdate, K>	The subscription which trigger this message.	BaseSubscriptionMessage.subscription
title	readonly	string	The title of the channel after it was updated.	-

Methods

checkMessageType()

checkMessageType<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