TwurpleAuthenticationGetting dataExamplesFAQMigration

sendExtensionChatMessage

Definition

sendExtensionChatMessage(config, broadcaster, extensionVersion, text)

async

Sends a chat message in the name of the extension to 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 to send a chat message to.

extensionVersionstringnone

The version of the extension.

textstringnone

The text to send to the channel.

Return type: void