Class SoulFireChat

Index

Constructors

Methods

command complete send waitFor watch whisper

Constructors

constructor

new SoulFireChat(
    instanceId: string,
    botId: string,
    client: Client<typeof ChatService>,
    actionOptions: (options?: CallOptions) => CallOptions | undefined,
    eventStream?: BotEventStream,
): SoulFireChat
Parameters
- instanceId: string
- botId: string
- client: Client<typeof ChatService>
- actionOptions: (options?: CallOptions) => CallOptions | undefined
- OptionaleventStream: BotEventStream
Returns SoulFireChat
- Defined in sdk/typescript/src/chat.ts:57

Methods

command

command(
command: string,
options?: ChatMutationOptions,
): Effect<BotActionResult, SoulFireOperationError>
Runs a command; the leading / is optional.
Parameters
- command: string
- options: ChatMutationOptions = {}
Returns Effect<BotActionResult, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:97

complete

complete(
input: string,
options?: TabCompleteOptions,
): Effect<TabCompleteResponse, SoulFireOperationError>
Tab-completion suggestions for input (a command if it starts with /) at options.cursor, which defaults to the end of input.
Parameters
- input: string
- options: TabCompleteOptions = {}
Returns Effect<TabCompleteResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:154

send

send(
message: string,
options?: ChatMutationOptions,
): Effect<BotActionResult, SoulFireOperationError>
To public chat. message can't be blank or longer than 256 characters.
Parameters
- message: string
- options: ChatMutationOptions = {}
Returns Effect<BotActionResult, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:70

waitFor

waitFor(
matcher: ChatMatcher,
options?: WaitForChatOptions,
): Effect<ChatMatch, SoulFireOperationError>
The next chat event matching matcher (as in watch). No timeout unless timeoutMs is set.
Parameters
- matcher: ChatMatcher
- options: WaitForChatOptions = {}
Returns Effect<ChatMatch, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:205

watch

watch(
matcher: ChatMatcher,
options?: WatchChatOptions,
): Stream<ChatMatch, SoulFireOperationError>
Chat events matching matcher, as they arrive, until the caller stops iterating. A string matches as a substring of the plain text; a RegExp's groups go in captures and groups. options.sources keeps only those sources.
Parameters
- matcher: ChatMatcher
- options: WatchChatOptions = {}
Returns Stream<ChatMatch, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:176

whisper

whisper(
    recipient: string,
    message: string,
    options?: ChatMutationOptions,
): Effect<BotActionResult, SoulFireOperationError>
Sends /msg <recipient> <message>.
Parameters
- recipient: string
- message: string
- options: ChatMutationOptions = {}
Returns Effect<BotActionResult, SoulFireOperationError>
- Defined in sdk/typescript/src/chat.ts:124