Interface ZoomNodeParameters

Source
interface ZoomNodeParameters {
    additionalFields?:
        | {
            agenda?: string;
            duration?: number;
            password?: string;
            scheduleFor?: string;
            settings?: {
                alternativeHosts?: string;
                audio?: "both"
                | "telephony"
                | "voip";
                autoRecording?: "none" | "cloud" | "local";
                cnMeeting?: boolean;
                hostVideo?: boolean;
                inMeeting?: boolean;
                joinBeforeHost?: boolean;
                muteUponEntry?: boolean;
                participantVideo?: boolean;
                registrationType?: 1 | 3 | 2;
                watermark?: boolean;
            };
            startTime?: string;
            timeZone?: string;
            type?: 1
            | 3
            | 2
            | 8;
        }
        | {
            occurrenceId?: string;
            showPreviousOccurrences?: boolean;
        }
        | {
            occurrenceId?: string;
            scheduleForReminder?: boolean;
        };
    authentication?: "oAuth2"
    | "accessToken";
    filters?: { type?: "upcoming" | "scheduled" | "live" };
    limit?: number;
    meetingId?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete";
    resource?: "meeting";
    returnAll?: boolean;
    topic?: string;
    updateFields?: {
        agenda?: string;
        duration?: number;
        password?: string;
        scheduleFor?: string;
        settings?: {
            alternativeHosts?: string;
            audio?: "both"
            | "telephony"
            | "voip";
            autoRecording?: "none" | "cloud" | "local";
            cnMeeting?: boolean;
            hostVideo?: boolean;
            inMeeting?: boolean;
            joinBeforeHost?: boolean;
            muteUponEntry?: boolean;
            participantVideo?: boolean;
            registrationType?: 1 | 3 | 2;
            watermark?: boolean;
        };
        startTime?: string;
        timeZone?: string;
        topic?: string;
        type?: 1
        | 3
        | 2
        | 8;
    };
}

Properties§

Source§

readonly additionalFields?:
    | {
        agenda?: string;
        duration?: number;
        password?: string;
        scheduleFor?: string;
        settings?: {
            alternativeHosts?: string;
            audio?: "both"
            | "telephony"
            | "voip";
            autoRecording?: "none" | "cloud" | "local";
            cnMeeting?: boolean;
            hostVideo?: boolean;
            inMeeting?: boolean;
            joinBeforeHost?: boolean;
            muteUponEntry?: boolean;
            participantVideo?: boolean;
            registrationType?: 1 | 3 | 2;
            watermark?: boolean;
        };
        startTime?: string;
        timeZone?: string;
        type?: 1
        | 3
        | 2
        | 8;
    }
    | {
        occurrenceId?: string;
        showPreviousOccurrences?: boolean;
    }
    | {
        occurrenceId?: string;
        scheduleForReminder?: boolean;
    }

Default: {}

Source§

readonly authentication?: "oAuth2" | "accessToken"

Default: "accessToken"

Source§

readonly filters?: { type?: "upcoming" | "scheduled" | "live" }

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 30 Type options: {"minValue":1,"maxValue":300}

Source§

readonly meetingId?: string

Meeting ID

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "create"

Source§

readonly resource?: "meeting"

Default: "meeting"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly topic?: string

Topic of the meeting

Source§

readonly updateFields?: {
    agenda?: string;
    duration?: number;
    password?: string;
    scheduleFor?: string;
    settings?: {
        alternativeHosts?: string;
        audio?: "both" | "telephony" | "voip";
        autoRecording?: "none" | "cloud" | "local";
        cnMeeting?: boolean;
        hostVideo?: boolean;
        inMeeting?: boolean;
        joinBeforeHost?: boolean;
        muteUponEntry?: boolean;
        participantVideo?: boolean;
        registrationType?: 1 | 3 | 2;
        watermark?: boolean;
    };
    startTime?: string;
    timeZone?: string;
    topic?: string;
    type?: 1
    | 3
    | 2
    | 8;
}

Default: {}