Class ScriptEventCommandMessageSignal`Beta`

Allows for registering an event handler that responds to inbound /scriptevent commands.

Index

Constructors

Methods

subscribe unsubscribe

Constructors

`Protected`constructor

new ScriptEventCommandMessageSignal(): ScriptEventCommandMessageSignal
Beta
Returns ScriptEventCommandMessageSignal

Methods

subscribe(
callback: (arg: ScriptEventCommandMessageEvent) => void,
options?: ScriptEventMessageFilterOptions,
): (arg: ScriptEventCommandMessageEvent) => void
Beta
Parameters
- callback: (arg: ScriptEventCommandMessageEvent) => void
- Optionaloptions: ScriptEventMessageFilterOptions
Returns (arg: ScriptEventCommandMessageEvent) => void
Remarks
Registers a new ScriptEvent handler.

unsubscribe

unsubscribe(callback: (arg: ScriptEventCommandMessageEvent) => void): void
Beta
Parameters
- callback: (arg: ScriptEventCommandMessageEvent) => void
Returns void
Remarks
Unsubscribes a particular handler for a ScriptEvent event.

Throws
This function can throw errors.