Class TwitchApi

Index

Constructors

Methods

dispatchInbound dropPlayer historyFor post tune tunedLoginsFor untune whoTuned

Constructors

constructor

new TwitchApi(): TwitchApi
Returns TwitchApi

Methods

`Static`dispatchInbound

dispatchInbound(n: NormalizedInbound): Promise<void>
Inbound entry point — the backend reader's down-call.
Parameters
- n: NormalizedInbound
Returns Promise<void>
- Defined in packages/server/src/mud/api/twitch.ts:113

`Static`dropPlayer

dropPlayer(playerId: string): Promise<string[]>
Drop a player from every tuned channel (logout). Returns the broadcaster ids that emptied — the backend reader unsubscribes each.
Parameters
- playerId: string
Returns Promise<string[]>
- Defined in packages/server/src/mud/api/twitch.ts:121

`Static`historyFor

historyFor(login: string): Promise<readonly MessageFrame<unknown>[]>
The history ring for a channel (by login).
Parameters
- login: string
Returns Promise<readonly MessageFrame<unknown>[]>
- Defined in packages/server/src/mud/api/twitch.ts:99

`Static`post

post(speaker: Stuff, login: string, text: string): Promise<TwitchPostResult>
Post outbound to a tuned channel (by login) as the speaker.
Parameters
- speaker: Stuff
- login: string
- text: string
Returns Promise<TwitchPostResult>
- Defined in packages/server/src/mud/api/twitch.ts:104

`Static`tune

tune(avatar: default, login: string): Promise<TwitchTuneResult>
Tune a player in to a Twitch channel by login (lazy resolve + 0→1).
Parameters
- avatar: default
- login: string
Returns Promise<TwitchTuneResult>
- Defined in packages/server/src/mud/api/twitch.ts:76

`Static`tunedLoginsFor

tunedLoginsFor(avatar: default): Promise<string[]>
The Twitch logins a player is currently tuned in to.
Parameters
- avatar: default
Returns Promise<string[]>
- Defined in packages/server/src/mud/api/twitch.ts:89

`Static`untune

untune(
avatar: default,
login: string,
): Promise<{ login?: string; ok: boolean; reason?: string }>
Tune a player out by login (1→0 edge).
Parameters
- avatar: default
- login: string
Returns Promise<{ login?: string; ok: boolean; reason?: string }>
- Defined in packages/server/src/mud/api/twitch.ts:81

`Static`whoTuned

whoTuned(login: string): Promise<default[]>
Online Avatars tuned in to a channel (by login).
Parameters
- login: string
Returns Promise<default[]>
- Defined in packages/server/src/mud/api/twitch.ts:94