Interface Invite

interface Invite {
    candidates: readonly Candidate[];
    error: 487 | 603 | 200 | 404 | 408;
    from: string;
    group: boolean;
    inviteRequest: boolean;
    mediatypes: MediaType;
    state: "ACCEPTED" | "DECLINED_BY_CREATOR" | "DECLINED_BY_TIMEOUT" | "DECLINED";
    to: string;
}

Properties

candidates error from group inviteRequest mediatypes state to

Properties

Readonly candidates

candidates: readonly Candidate[]

List of candidates that received the invite

Readonly error

error: 487 | 603 | 200 | 404 | 408

Code error when an invite is declined

Readonly from

from: string

who sent the invite

Readonly group

group: boolean

Set to true when the invite is sent to a group

Readonly inviteRequest

inviteRequest: boolean

Set to true when the invite is related with an invitation request

Readonly mediatypes

mediatypes: MediaType

Indicates the media used in the conference

Readonly state

state: "ACCEPTED" | "DECLINED_BY_CREATOR" | "DECLINED_BY_TIMEOUT" | "DECLINED"

specify what happened with the invite

Readonly to

to: string

who received the invite

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc