TwurpleAuthenticationGetting dataExamplesFAQMigration

sendExtensionPubSubWhisperMessage

Definition

sendExtensionPubSubWhisperMessage(config, broadcaster, targets, message)

async

Sends an Extension PubSub message to specified users in the context of a channel.

ParameterTypeRequiredDefaultDescription
configEbsCallConfignonesee below
config.clientIdstringnone

The client ID of the extension.

config.ownerIdstringnone

The user ID of the extension's owner.

config.secretstringnone

A valid extension secret to sign the JWT with.

config.ttlnumbernone

The time the JWT should be valid for, in seconds.

Defaults to 1 minute (60 seconds).

broadcaster
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

none

The broadcaster that is used as the context of the message.

targets
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

|
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

[]
none

The user(s) you want to send the message to.

messagestringnone

The content of the message.

Return type: void