Zoom Meeting SDK for Web - Component View
    Preparing search index...

    Interface JoinOptions

    Arguments and options for joining a meeting.

    interface JoinOptions {
        customerKey?: string;
        error?: Function;
        meetingNumber: string;
        password?: string;
        recordingToken?: string;
        sdkKey?: string;
        signature: string;
        success?: Function;
        tk?: string;
        userEmail?: string;
        userName: string;
        zak?: string;
    }
    Index

    Properties

    customerKey? error? meetingNumber password? recordingToken? sdkKey? signature success? tk? userEmail? userName zak?

    Properties

    customerKey?: string

    The user's customer key.

    error?: Function

    Join error callback.

    meetingNumber: string

    The Zoom Meeting number.

    password?: string

    The meeting password.

    recordingToken?: string

    Optional token to allow local recording. See Get a meeting's join token for local recording for details.

    sdkKey?: string

    The sdkKey is deprecated for the joinOptions() after v4.0.0. You can just use signature.

    The Meeting SDK SDK key or client ID.

    signature: string

    After v5.0.0, the signature is required to have the appKey field appKey:sdkKey or appKey:clientId. if the appKey is not included, you cannot join the meeting.

    The generated signature to create or join the meeting. See Generate the SDK JWT for details.

    success?: Function

    Join success callback.

    tk?: string

    Optional 'tk' param to join a webinar with registration.

    userEmail?: string

    The user's email address.

    userName: string

    The user's name.

    zak?: string

    Optional 'zak' param to start a meeting or webinar with OAuth.

    Settings

    Member Visibility

    On This Page

    Properties