Interface IMeetingBotProvider

One way of joining meetings. A provider ships as an extension pack with the kind meeting-provider; the host registers it on the manager.

interface IMeetingBotProvider {
    name: string;
    platforms: readonly MeetingPlatform[];
    capabilities: MeetingBotCapabilities;
    verifyEvent(ctx, run): ProviderVerificationResult;
    parseEvent(ctx): ProviderParseResult;
    checkJoinUrl(url): {
        ok: true;
        platform: MeetingPlatform;
    } | {
        ok: false;
        message: string;
    };
    dispatch(input): Promise<DispatchResult>;
    command(runId, command): Promise<void>;
    deleteRun(input): Promise<{
        deleted: boolean;
    }>;
    usage(input): Promise<ProviderUsage[]>;
}

Implemented by

MockMeetingBotProvider

Index

Methods

verifyEvent parseEvent checkJoinUrl dispatch command deleteRun usage

Properties

name platforms capabilities

Methods

verifyEvent

verifyEvent(ctx, run): ProviderVerificationResult
The provider's own authentication of a report: a platform's signature scheme, or the worker's per-run token against the run's dispatch record.
Parameters
- ctx: ProviderEventContext
- run: undefined | MeetingRunRecord
Returns ProviderVerificationResult
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:99

parseEvent

parseEvent(ctx): ProviderParseResult
Turns a verified report into the channel's events, each with a stable id; throws on a report it cannot read. When the report was verified against a run, its caller applies only the events that name that run: a worker's per-run token speaks for its own run alone.
Parameters
- ctx: ProviderEventContext
Returns ProviderParseResult
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:105

checkJoinUrl

checkJoinUrl(url): {
    ok: true;
    platform: MeetingPlatform;
} | {
    ok: false;
    message: string;
}
Tells a join url's platform, or why it is refused.
Parameters
- url: string
Returns {
    ok: true;
    platform: MeetingPlatform;
} | {
    ok: false;
    message: string;
}
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:107

dispatch

dispatch(input): Promise<DispatchResult>
Hands the run to a worker with the room and the tokens minted for it; rejects when the run cannot start.
Parameters
- input: DispatchInput
Returns Promise<DispatchResult>
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:109

command

command(runId, command): Promise<void>
Sends a command to the run's bot. A provider passes on no audio of a run before the run's first startCapture, and none after a suspendCapture until the next startCapture: the manager sends startCapture only once the run's notice is confirmed posted and its stop monitor is healthy.
Parameters
- runId: string
- command: ProviderCommand
Returns Promise<void>
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:116

deleteRun

deleteRun(input): Promise<{
deleted: boolean;
}>
Deletes a provider's own copies of a run. Ours keep none; the method stands so a purge always has an answer.
Parameters
- input: {
  runId: string;
  }
  - runId: string
Returns Promise<{
deleted: boolean;
}>
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:118

usage

usage(input): Promise<ProviderUsage[]>
Each run asked for (every run the provider knows when runIds is absent), alive or not, with the seconds it has counted.
Parameters
- input: {
  runIds?: string[];
  }
  - Optional runIds?: string[]
Returns Promise<ProviderUsage[]>
- Defined in src/io/channels/meetings/IMeetingBotProvider.ts:120

Properties

`Readonly` name

name: string

The name the manager registers the provider under; runs and reports carry it.

`Readonly` platforms

platforms: readonly MeetingPlatform[]

The platforms the provider joins.

`Readonly` capabilities

capabilities: MeetingBotCapabilities

What the provider declares about itself; the notice and the stop path follow from it.