Interface: Api
Methods
create
▸ create(args): Promise<Status<{ created_at?: string ; id: string ; status?: "unknown" | "ready" | "running" | "ended" ; updated_at?: string }>>
Creates a new meeting via CRUD
Parameters
| Name | Type |
|---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.accessToken? | string |
args.apiAddress | string |
args.headers? | HeadersInit |
Returns
Promise<Status<{ created_at?: string ; id: string ; status?: "unknown" | "ready" | "running" | "ended" ; updated_at?: string }>>
meeting id
join
▸ join(args): Promise<Status<{ location: string ; token: string }>>
Joins a meeting for particular participantId and participantSecret
Parameters
| Name | Type |
|---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.apiAddress | string |
args.headers? | HeadersInit |
args.meetingId | string |
args.participantId | string |
args.participantSecret | string |
Returns
Promise<Status<{ location: string ; token: string }>>
location path to be able to connect to WebSocket for all the meeting updates
participants
▸ participants(args): Promise<Status<{ created_at: string ; id: string ; meeting_id: string ; participant_secret: string ; status: "ready" | "joined" | "left" | "removed" ; updated_at: string }>>
Creates participant_id and participant_secret for the given meetingId
Parameters
| Name | Type |
|---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.accessToken? | string |
args.apiAddress | string |
args.headers? | HeadersInit |
args.meetingId | string |
Returns
Promise<Status<{ created_at: string ; id: string ; meeting_id: string ; participant_secret: string ; status: "ready" | "joined" | "left" | "removed" ; updated_at: string }>>
terminate
▸ terminate(args): Promise<Status<unknown>>
Terminates meeting with the specified meetingId
Parameters
| Name | Type |
|---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.accessToken? | string |
args.apiAddress | string |
args.headers? | HeadersInit |
args.meetingId | string |
Returns
Promise<Status<unknown>>
token
▸ token(args): Promise<Status<{ access_token: string ; expires_in: number ; scope: string ; token_type: "Bearer" }>>
Creates a new meeting via CRUD
Parameters
| Name | Type |
|---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.apiAddress | string |
args.headers? | HeadersInit |
args.token | string |
Returns
Promise<Status<{ access_token: string ; expires_in: number ; scope: string ; token_type: "Bearer" }>>
obj with access_token