Interface Invite

Hierarchy

  • Invite

Properties

candidates error from group inviteRequest mediatypes state to

Methods

getCandidates

Properties

Readonly candidates

candidates: readonly Candidate[]

List of candidates that received the invite

Readonly error

error: 200 | 404 | 487 | 603 | 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

Methods

getCandidates

  • Deprecated

    Use candidates instead

    Returns {
        address: string;
        direction: "incoming";
        group: boolean;
        state: undefined | "rejected" | "accepted" | "missed";
        type: "invite";
    }[]

Settings

Member Visibility

Theme

Generated using TypeDoc