diff --git a/classes/PlugNmeet.html b/classes/PlugNmeet.html index 40b6bea..a41aa4a 100644 --- a/classes/PlugNmeet.html +++ b/classes/PlugNmeet.html @@ -1,4 +1,4 @@ -PlugNmeet | plugNmeet JS SDK - v1.4.0

Class PlugNmeet

Implements

Constructors

constructor +PlugNmeet | plugNmeet JS SDK - v1.4.0

Class PlugNmeet

Implements

Constructors

constructor

Methods

createRoom getJoinToken isRoomActive @@ -16,32 +16,32 @@

Constructors

constructor

  • new PlugNmeet(serverUrl, apiKey, apiSecret): PlugNmeet

  • Parameters

    • serverUrl: string

      plugNmeet server URL

    • apiKey: string

      plugNmeet API_Key

    • apiSecret: string

      plugNmeet API_Secret

      -

    Returns PlugNmeet

Methods

createRoom

Returns PlugNmeet

Methods

createRoom

getJoinToken

getJoinToken

isRoomActive

isRoomActive

getActiveRoomInfo

getActiveRoomInfo

getActiveRoomsInfo

getActiveRoomsInfo

fetchPastRoomsInfo

fetchPastRoomsInfo

endRoom

endRoom

fetchAnalytics

fetchAnalytics

deleteAnalytics

deleteAnalytics

getAnalyticsDownloadToken

getAnalyticsDownloadToken

fetchRecordings

fetchRecordings

deleteRecordings

deleteRecordings

getRecordingDownloadToken

getRecordingDownloadToken

getClientFiles

getClientFiles

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/interfaces/PlugNmeetAPI.html b/interfaces/PlugNmeetAPI.html index 63cbc76..d309f7a 100644 --- a/interfaces/PlugNmeetAPI.html +++ b/interfaces/PlugNmeetAPI.html @@ -1,4 +1,4 @@ -PlugNmeetAPI | plugNmeet JS SDK - v1.4.0

Interface PlugNmeetAPI

interface PlugNmeetAPI {
    createRoom(params: CreateRoomParams): Promise<CreateRoomResponse>;
    getJoinToken(params: JoinTokenParams): Promise<JoinTokenResponse>;
    isRoomActive(params: IsRoomActiveParams): Promise<IsRoomActiveResponse>;
    getActiveRoomInfo(params: ActiveRoomInfoParams): Promise<ActiveRoomInfoResponse>;
    getActiveRoomsInfo(): Promise<ActiveRoomsInfoResponse>;
    fetchPastRoomsInfo(params: FetchPastRoomsInfoParams): Promise<FetchRoomsInfoResponse>;
    endRoom(params: EndRoomParams): Promise<EndRoomResponse>;
    fetchAnalytics(params: FetchAnalyticsParams): Promise<FetchAnalyticsResponse>;
    deleteAnalytics(params: DeleteAnalyticsParams): Promise<DeleteAnalyticsResponse>;
    getAnalyticsDownloadToken(params: AnalyticsDownloadTokenParams): Promise<AnalyticsDownloadTokenResponse>;
    fetchRecordings(params: FetchRecordingsParams): Promise<FetchRecordingsResponse>;
    deleteRecordings(params: DeleteRecordingsParams): Promise<DeleteRecordingsResponse>;
    getRecordingDownloadToken(params: RecordingDownloadTokenParams): Promise<RecordingDownloadTokenResponse>;
    getClientFiles(): Promise<ClientFilesResponse>;
}

Implemented by

Methods

createRoom +PlugNmeetAPI | plugNmeet JS SDK - v1.4.0

Interface PlugNmeetAPI

interface PlugNmeetAPI {
    createRoom(params: CreateRoomParams): Promise<CreateRoomResponse>;
    getJoinToken(params: JoinTokenParams): Promise<JoinTokenResponse>;
    isRoomActive(params: IsRoomActiveParams): Promise<IsRoomActiveResponse>;
    getActiveRoomInfo(params: ActiveRoomInfoParams): Promise<ActiveRoomInfoResponse>;
    getActiveRoomsInfo(): Promise<ActiveRoomsInfoResponse>;
    fetchPastRoomsInfo(params: FetchPastRoomsInfoParams): Promise<FetchRoomsInfoResponse>;
    endRoom(params: EndRoomParams): Promise<EndRoomResponse>;
    fetchAnalytics(params: FetchAnalyticsParams): Promise<FetchAnalyticsResponse>;
    deleteAnalytics(params: DeleteAnalyticsParams): Promise<DeleteAnalyticsResponse>;
    getAnalyticsDownloadToken(params: AnalyticsDownloadTokenParams): Promise<AnalyticsDownloadTokenResponse>;
    fetchRecordings(params: FetchRecordingsParams): Promise<FetchRecordingsResponse>;
    deleteRecordings(params: DeleteRecordingsParams): Promise<DeleteRecordingsResponse>;
    getRecordingDownloadToken(params: RecordingDownloadTokenParams): Promise<RecordingDownloadTokenResponse>;
    getClientFiles(): Promise<ClientFilesResponse>;
}

Implemented by

Methods

createRoom getJoinToken isRoomActive getActiveRoomInfo @@ -14,30 +14,30 @@ getClientFiles

Methods

createRoom

getJoinToken

getJoinToken

isRoomActive

isRoomActive

getActiveRoomInfo

getActiveRoomInfo

getActiveRoomsInfo

getActiveRoomsInfo

fetchPastRoomsInfo

fetchPastRoomsInfo

endRoom

endRoom

fetchAnalytics

fetchAnalytics

deleteAnalytics

deleteAnalytics

getAnalyticsDownloadToken

getAnalyticsDownloadToken

fetchRecordings

fetchRecordings

deleteRecordings

deleteRecordings

getRecordingDownloadToken

getRecordingDownloadToken

getClientFiles

getClientFiles

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/types/ActiveRoomInfo.html b/types/ActiveRoomInfo.html index 67f0e2f..8a1f175 100644 --- a/types/ActiveRoomInfo.html +++ b/types/ActiveRoomInfo.html @@ -1 +1 @@ -ActiveRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfo

ActiveRoomInfo: {
    room_title: string;
    room_id: string;
    sid: string;
    joined_participants: number;
    is_running: boolean;
    is_recording: boolean;
    is_active_rtmp: boolean;
    webhook_url: string;
    creation_time: number;
    metadata: string;
}

Settings

Member Visibility
+ActiveRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfo

ActiveRoomInfo: {
    room_title: string;
    room_id: string;
    sid: string;
    joined_participants: number;
    is_running: boolean;
    is_recording: boolean;
    is_active_rtmp: boolean;
    webhook_url: string;
    creation_time: number;
    metadata: string;
}

Settings

Member Visibility
diff --git a/types/ActiveRoomInfoParams.html b/types/ActiveRoomInfoParams.html index c9859f5..e59575a 100644 --- a/types/ActiveRoomInfoParams.html +++ b/types/ActiveRoomInfoParams.html @@ -1 +1 @@ -ActiveRoomInfoParams | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfoParams

ActiveRoomInfoParams: {
    room_id: string;
}

Settings

Member Visibility
+ActiveRoomInfoParams | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfoParams

ActiveRoomInfoParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/ActiveRoomInfoResponse.html b/types/ActiveRoomInfoResponse.html index aa9ebcf..de110c1 100644 --- a/types/ActiveRoomInfoResponse.html +++ b/types/ActiveRoomInfoResponse.html @@ -1 +1 @@ -ActiveRoomInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfoResponse

ActiveRoomInfoResponse: {
    status: boolean;
    msg: string;
    room?: Room;
}

Settings

Member Visibility
+ActiveRoomInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomInfoResponse

ActiveRoomInfoResponse: {
    status: boolean;
    msg: string;
    room?: Room;
}

Settings

Member Visibility
diff --git a/types/ActiveRoomsInfoResponse.html b/types/ActiveRoomsInfoResponse.html index 9090122..2921308 100644 --- a/types/ActiveRoomsInfoResponse.html +++ b/types/ActiveRoomsInfoResponse.html @@ -1 +1 @@ -ActiveRoomsInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomsInfoResponse

ActiveRoomsInfoResponse: {
    status: boolean;
    msg: string;
    rooms?: Room[];
}

Settings

Member Visibility
+ActiveRoomsInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias ActiveRoomsInfoResponse

ActiveRoomsInfoResponse: {
    status: boolean;
    msg: string;
    rooms?: Room[];
}

Settings

Member Visibility
diff --git a/types/AnalyticsDownloadTokenParams.html b/types/AnalyticsDownloadTokenParams.html index bc73b13..41afb11 100644 --- a/types/AnalyticsDownloadTokenParams.html +++ b/types/AnalyticsDownloadTokenParams.html @@ -1 +1 @@ -AnalyticsDownloadTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsDownloadTokenParams

AnalyticsDownloadTokenParams: {
    file_id: string;
}

Settings

Member Visibility
+AnalyticsDownloadTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsDownloadTokenParams

AnalyticsDownloadTokenParams: {
    file_id: string;
}

Settings

Member Visibility
diff --git a/types/AnalyticsDownloadTokenResponse.html b/types/AnalyticsDownloadTokenResponse.html index 0635602..8dfcdec 100644 --- a/types/AnalyticsDownloadTokenResponse.html +++ b/types/AnalyticsDownloadTokenResponse.html @@ -1 +1 @@ -AnalyticsDownloadTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsDownloadTokenResponse

AnalyticsDownloadTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
+AnalyticsDownloadTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsDownloadTokenResponse

AnalyticsDownloadTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
diff --git a/types/AnalyticsInfo.html b/types/AnalyticsInfo.html index 9a174a3..91e843e 100644 --- a/types/AnalyticsInfo.html +++ b/types/AnalyticsInfo.html @@ -1 +1 @@ -AnalyticsInfo | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsInfo

AnalyticsInfo: {
    room_id: string;
    file_id: string;
    file_name: string;
    file_size: number;
    creation_time: number;
    room_creation_time: number;
}

Settings

Member Visibility
+AnalyticsInfo | plugNmeet JS SDK - v1.4.0

Type Alias AnalyticsInfo

AnalyticsInfo: {
    room_id: string;
    file_id: string;
    file_name: string;
    file_size: number;
    creation_time: number;
    room_creation_time: number;
}

Settings

Member Visibility
diff --git a/types/BreakoutRoomFeatures.html b/types/BreakoutRoomFeatures.html index 4c89e5c..6789430 100644 --- a/types/BreakoutRoomFeatures.html +++ b/types/BreakoutRoomFeatures.html @@ -1 +1 @@ -BreakoutRoomFeatures | plugNmeet JS SDK - v1.4.0

Type Alias BreakoutRoomFeatures

BreakoutRoomFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
+BreakoutRoomFeatures | plugNmeet JS SDK - v1.4.0

Type Alias BreakoutRoomFeatures

BreakoutRoomFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/ChatFeaturesParams.html b/types/ChatFeaturesParams.html index 1f9eedd..9792eb4 100644 --- a/types/ChatFeaturesParams.html +++ b/types/ChatFeaturesParams.html @@ -1 +1 @@ -ChatFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias ChatFeaturesParams

ChatFeaturesParams: {
    allow_chat: boolean;
    allow_file_upload: boolean;
    allowed_file_types: string[];
    max_file_size: number;
}

Settings

Member Visibility
+ChatFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias ChatFeaturesParams

ChatFeaturesParams: {
    allow_chat: boolean;
    allow_file_upload: boolean;
    allowed_file_types: string[];
    max_file_size: number;
}

Settings

Member Visibility
diff --git a/types/ClientFilesResponse.html b/types/ClientFilesResponse.html index 460850a..fb41b0f 100644 --- a/types/ClientFilesResponse.html +++ b/types/ClientFilesResponse.html @@ -1 +1 @@ -ClientFilesResponse | plugNmeet JS SDK - v1.4.0

Type Alias ClientFilesResponse

ClientFilesResponse: {
    status: boolean;
    msg: string;
    css?: string[];
    js?: string[];
}

Settings

Member Visibility
+ClientFilesResponse | plugNmeet JS SDK - v1.4.0

Type Alias ClientFilesResponse

ClientFilesResponse: {
    status: boolean;
    msg: string;
    css?: string[];
    js?: string[];
}

Settings

Member Visibility
diff --git a/types/CreateRoomParams.html b/types/CreateRoomParams.html index 4a85fb9..41990f3 100644 --- a/types/CreateRoomParams.html +++ b/types/CreateRoomParams.html @@ -1 +1 @@ -CreateRoomParams | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomParams

CreateRoomParams: {
    room_id: string;
    max_participants?: number;
    empty_timeout?: number;
    metadata: RooMetadata;
}

Settings

Member Visibility
+CreateRoomParams | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomParams

CreateRoomParams: {
    room_id: string;
    max_participants?: number;
    empty_timeout?: number;
    metadata: RooMetadata;
}

Settings

Member Visibility
diff --git a/types/CreateRoomResponse.html b/types/CreateRoomResponse.html index 05bee62..3913eb0 100644 --- a/types/CreateRoomResponse.html +++ b/types/CreateRoomResponse.html @@ -1 +1 @@ -CreateRoomResponse | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomResponse

CreateRoomResponse: {
    status: boolean;
    msg: string;
    roomInfo?: CreateRoomResponseRoomInfo;
}

Settings

Member Visibility
+CreateRoomResponse | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomResponse

CreateRoomResponse: {
    status: boolean;
    msg: string;
    roomInfo?: CreateRoomResponseRoomInfo;
}

Settings

Member Visibility
diff --git a/types/CreateRoomResponseRoomInfo.html b/types/CreateRoomResponseRoomInfo.html index 69d1d5b..89b1079 100644 --- a/types/CreateRoomResponseRoomInfo.html +++ b/types/CreateRoomResponseRoomInfo.html @@ -1 +1 @@ -CreateRoomResponseRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomResponseRoomInfo

CreateRoomResponseRoomInfo: {
    sid: string;
    name: string;
    max_participants: number;
    empty_timeout: number;
    creation_time: number;
    turn_password: string;
    enabled_codecs: any[];
    metadata: string;
}

Settings

Member Visibility
+CreateRoomResponseRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias CreateRoomResponseRoomInfo

CreateRoomResponseRoomInfo: {
    sid: string;
    name: string;
    max_participants: number;
    empty_timeout: number;
    creation_time: number;
    turn_password: string;
    enabled_codecs: any[];
    metadata: string;
}

Settings

Member Visibility
diff --git a/types/DeleteAnalyticsParams.html b/types/DeleteAnalyticsParams.html index a2716d4..f5d77d5 100644 --- a/types/DeleteAnalyticsParams.html +++ b/types/DeleteAnalyticsParams.html @@ -1 +1 @@ -DeleteAnalyticsParams | plugNmeet JS SDK - v1.4.0

Type Alias DeleteAnalyticsParams

DeleteAnalyticsParams: {
    file_id: string;
}

Settings

Member Visibility
+DeleteAnalyticsParams | plugNmeet JS SDK - v1.4.0

Type Alias DeleteAnalyticsParams

DeleteAnalyticsParams: {
    file_id: string;
}

Settings

Member Visibility
diff --git a/types/DeleteAnalyticsResponse.html b/types/DeleteAnalyticsResponse.html index c40058e..cd52467 100644 --- a/types/DeleteAnalyticsResponse.html +++ b/types/DeleteAnalyticsResponse.html @@ -1 +1 @@ -DeleteAnalyticsResponse | plugNmeet JS SDK - v1.4.0

Type Alias DeleteAnalyticsResponse

DeleteAnalyticsResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
+DeleteAnalyticsResponse | plugNmeet JS SDK - v1.4.0

Type Alias DeleteAnalyticsResponse

DeleteAnalyticsResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
diff --git a/types/DeleteRecordingsParams.html b/types/DeleteRecordingsParams.html index d2ec979..043a8f2 100644 --- a/types/DeleteRecordingsParams.html +++ b/types/DeleteRecordingsParams.html @@ -1 +1 @@ -DeleteRecordingsParams | plugNmeet JS SDK - v1.4.0

Type Alias DeleteRecordingsParams

DeleteRecordingsParams: {
    record_id: string;
}

Settings

Member Visibility
+DeleteRecordingsParams | plugNmeet JS SDK - v1.4.0

Type Alias DeleteRecordingsParams

DeleteRecordingsParams: {
    record_id: string;
}

Settings

Member Visibility
diff --git a/types/DeleteRecordingsResponse.html b/types/DeleteRecordingsResponse.html index 98780f8..59e2bfc 100644 --- a/types/DeleteRecordingsResponse.html +++ b/types/DeleteRecordingsResponse.html @@ -1 +1 @@ -DeleteRecordingsResponse | plugNmeet JS SDK - v1.4.0

Type Alias DeleteRecordingsResponse

DeleteRecordingsResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
+DeleteRecordingsResponse | plugNmeet JS SDK - v1.4.0

Type Alias DeleteRecordingsResponse

DeleteRecordingsResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
diff --git a/types/DisplayExternalLinkFeatures.html b/types/DisplayExternalLinkFeatures.html index 2198191..e7e5a5f 100644 --- a/types/DisplayExternalLinkFeatures.html +++ b/types/DisplayExternalLinkFeatures.html @@ -1 +1 @@ -DisplayExternalLinkFeatures | plugNmeet JS SDK - v1.4.0

Type Alias DisplayExternalLinkFeatures

DisplayExternalLinkFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
+DisplayExternalLinkFeatures | plugNmeet JS SDK - v1.4.0

Type Alias DisplayExternalLinkFeatures

DisplayExternalLinkFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/EndRoomParams.html b/types/EndRoomParams.html index 65f047e..0f0303e 100644 --- a/types/EndRoomParams.html +++ b/types/EndRoomParams.html @@ -1 +1 @@ -EndRoomParams | plugNmeet JS SDK - v1.4.0

Type Alias EndRoomParams

EndRoomParams: {
    room_id: string;
}

Settings

Member Visibility
+EndRoomParams | plugNmeet JS SDK - v1.4.0

Type Alias EndRoomParams

EndRoomParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/EndRoomResponse.html b/types/EndRoomResponse.html index 5b3889f..f39e57d 100644 --- a/types/EndRoomResponse.html +++ b/types/EndRoomResponse.html @@ -1 +1 @@ -EndRoomResponse | plugNmeet JS SDK - v1.4.0

Type Alias EndRoomResponse

EndRoomResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
+EndRoomResponse | plugNmeet JS SDK - v1.4.0

Type Alias EndRoomResponse

EndRoomResponse: {
    status: boolean;
    msg: string;
}

Settings

Member Visibility
diff --git a/types/EndToEndEncryptionFeatures.html b/types/EndToEndEncryptionFeatures.html index d21ba93..76b6183 100644 --- a/types/EndToEndEncryptionFeatures.html +++ b/types/EndToEndEncryptionFeatures.html @@ -1 +1 @@ -EndToEndEncryptionFeatures | plugNmeet JS SDK - v1.4.0

Type Alias EndToEndEncryptionFeatures

EndToEndEncryptionFeatures: {
    is_enabled: boolean;
}

Settings

Member Visibility
+EndToEndEncryptionFeatures | plugNmeet JS SDK - v1.4.0

Type Alias EndToEndEncryptionFeatures

EndToEndEncryptionFeatures: {
    is_enabled: boolean;
}

Settings

Member Visibility
diff --git a/types/ExternalMediaPlayerFeatures.html b/types/ExternalMediaPlayerFeatures.html index bfaedcb..c35516a 100644 --- a/types/ExternalMediaPlayerFeatures.html +++ b/types/ExternalMediaPlayerFeatures.html @@ -1 +1 @@ -ExternalMediaPlayerFeatures | plugNmeet JS SDK - v1.4.0

Type Alias ExternalMediaPlayerFeatures

ExternalMediaPlayerFeatures: {
    allowed_external_media_player: boolean;
}

Settings

Member Visibility
+ExternalMediaPlayerFeatures | plugNmeet JS SDK - v1.4.0

Type Alias ExternalMediaPlayerFeatures

ExternalMediaPlayerFeatures: {
    allowed_external_media_player: boolean;
}

Settings

Member Visibility
diff --git a/types/FetchAnalyticsParams.html b/types/FetchAnalyticsParams.html index 6da41dc..f4ee3a1 100644 --- a/types/FetchAnalyticsParams.html +++ b/types/FetchAnalyticsParams.html @@ -1 +1 @@ -FetchAnalyticsParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsParams

FetchAnalyticsParams: {
    room_ids: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
+FetchAnalyticsParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsParams

FetchAnalyticsParams: {
    room_ids: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
diff --git a/types/FetchAnalyticsResponse.html b/types/FetchAnalyticsResponse.html index 348a406..d88dda2 100644 --- a/types/FetchAnalyticsResponse.html +++ b/types/FetchAnalyticsResponse.html @@ -1 +1 @@ -FetchAnalyticsResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsResponse

FetchAnalyticsResponse: {
    status: boolean;
    msg: string;
    result?: FetchAnalyticsResult;
}

Settings

Member Visibility
+FetchAnalyticsResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsResponse

FetchAnalyticsResponse: {
    status: boolean;
    msg: string;
    result?: FetchAnalyticsResult;
}

Settings

Member Visibility
diff --git a/types/FetchAnalyticsResult.html b/types/FetchAnalyticsResult.html index 1146132..f812fb0 100644 --- a/types/FetchAnalyticsResult.html +++ b/types/FetchAnalyticsResult.html @@ -1 +1 @@ -FetchAnalyticsResult | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsResult

FetchAnalyticsResult: {
    total_analytics: number;
    from: number;
    limit: number;
    order_by: string;
    analytics_list: AnalyticsInfo[];
}

Settings

Member Visibility
+FetchAnalyticsResult | plugNmeet JS SDK - v1.4.0

Type Alias FetchAnalyticsResult

FetchAnalyticsResult: {
    total_analytics: number;
    from: number;
    limit: number;
    order_by: string;
    analytics_list: AnalyticsInfo[];
}

Settings

Member Visibility
diff --git a/types/FetchPastRoomsInfoParams.html b/types/FetchPastRoomsInfoParams.html index 5870c85..a88e6df 100644 --- a/types/FetchPastRoomsInfoParams.html +++ b/types/FetchPastRoomsInfoParams.html @@ -1 +1 @@ -FetchPastRoomsInfoParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchPastRoomsInfoParams

FetchPastRoomsInfoParams: {
    room_ids?: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
+FetchPastRoomsInfoParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchPastRoomsInfoParams

FetchPastRoomsInfoParams: {
    room_ids?: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
diff --git a/types/FetchRecordingsParams.html b/types/FetchRecordingsParams.html index 070ebc7..4022134 100644 --- a/types/FetchRecordingsParams.html +++ b/types/FetchRecordingsParams.html @@ -1 +1 @@ -FetchRecordingsParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsParams

FetchRecordingsParams: {
    room_ids: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
+FetchRecordingsParams | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsParams

FetchRecordingsParams: {
    room_ids: string[];
    from?: number;
    limit?: number;
    order_by?: "ASC" | "DESC";
}

Settings

Member Visibility
diff --git a/types/FetchRecordingsResponse.html b/types/FetchRecordingsResponse.html index bb5b068..a4d304b 100644 --- a/types/FetchRecordingsResponse.html +++ b/types/FetchRecordingsResponse.html @@ -1 +1 @@ -FetchRecordingsResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsResponse

FetchRecordingsResponse: {
    status: boolean;
    msg: string;
    result?: FetchRecordingsResult;
}

Settings

Member Visibility
+FetchRecordingsResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsResponse

FetchRecordingsResponse: {
    status: boolean;
    msg: string;
    result?: FetchRecordingsResult;
}

Settings

Member Visibility
diff --git a/types/FetchRecordingsResult.html b/types/FetchRecordingsResult.html index a04f8b6..5a2bc53 100644 --- a/types/FetchRecordingsResult.html +++ b/types/FetchRecordingsResult.html @@ -1 +1 @@ -FetchRecordingsResult | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsResult

FetchRecordingsResult: {
    total_recordings: number;
    from: number;
    limit: number;
    order_by: string;
    recordings_list: RecordingInfo[];
}

Settings

Member Visibility
+FetchRecordingsResult | plugNmeet JS SDK - v1.4.0

Type Alias FetchRecordingsResult

FetchRecordingsResult: {
    total_recordings: number;
    from: number;
    limit: number;
    order_by: string;
    recordings_list: RecordingInfo[];
}

Settings

Member Visibility
diff --git a/types/FetchRoomsInfoResponse.html b/types/FetchRoomsInfoResponse.html index ea6751a..c6bc58b 100644 --- a/types/FetchRoomsInfoResponse.html +++ b/types/FetchRoomsInfoResponse.html @@ -1 +1 @@ -FetchRoomsInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchRoomsInfoResponse

FetchRoomsInfoResponse: {
    status: boolean;
    msg: string;
    result?: PastRoomInfoResult;
}

Settings

Member Visibility
+FetchRoomsInfoResponse | plugNmeet JS SDK - v1.4.0

Type Alias FetchRoomsInfoResponse

FetchRoomsInfoResponse: {
    status: boolean;
    msg: string;
    result?: PastRoomInfoResult;
}

Settings

Member Visibility
diff --git a/types/IngressFeatures.html b/types/IngressFeatures.html index 1a7fd56..336c47a 100644 --- a/types/IngressFeatures.html +++ b/types/IngressFeatures.html @@ -1 +1 @@ -IngressFeatures | plugNmeet JS SDK - v1.4.0

Type Alias IngressFeatures

IngressFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
+IngressFeatures | plugNmeet JS SDK - v1.4.0

Type Alias IngressFeatures

IngressFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/IsRoomActiveParams.html b/types/IsRoomActiveParams.html index 8c7555c..586339f 100644 --- a/types/IsRoomActiveParams.html +++ b/types/IsRoomActiveParams.html @@ -1 +1 @@ -IsRoomActiveParams | plugNmeet JS SDK - v1.4.0

Type Alias IsRoomActiveParams

IsRoomActiveParams: {
    room_id: string;
}

Settings

Member Visibility
+IsRoomActiveParams | plugNmeet JS SDK - v1.4.0

Type Alias IsRoomActiveParams

IsRoomActiveParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/IsRoomActiveResponse.html b/types/IsRoomActiveResponse.html index 5c712c9..1cf63c2 100644 --- a/types/IsRoomActiveResponse.html +++ b/types/IsRoomActiveResponse.html @@ -1 +1 @@ -IsRoomActiveResponse | plugNmeet JS SDK - v1.4.0

Type Alias IsRoomActiveResponse

IsRoomActiveResponse: {
    status: boolean;
    is_active?: boolean;
    msg: string;
}

Settings

Member Visibility
+IsRoomActiveResponse | plugNmeet JS SDK - v1.4.0

Type Alias IsRoomActiveResponse

IsRoomActiveResponse: {
    status: boolean;
    is_active?: boolean;
    msg: string;
}

Settings

Member Visibility
diff --git a/types/JoinTokenParams.html b/types/JoinTokenParams.html index 2d72f3f..24a4f00 100644 --- a/types/JoinTokenParams.html +++ b/types/JoinTokenParams.html @@ -1 +1 @@ -JoinTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenParams

JoinTokenParams: {
    room_id: string;
    user_info: JoinTokenUserInfo;
}

Settings

Member Visibility
+JoinTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenParams

JoinTokenParams: {
    room_id: string;
    user_info: JoinTokenUserInfo;
}

Settings

Member Visibility
diff --git a/types/JoinTokenResponse.html b/types/JoinTokenResponse.html index 3ea149e..359c58f 100644 --- a/types/JoinTokenResponse.html +++ b/types/JoinTokenResponse.html @@ -1 +1 @@ -JoinTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenResponse

JoinTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
+JoinTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenResponse

JoinTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
diff --git a/types/JoinTokenUserInfo.html b/types/JoinTokenUserInfo.html index 4505631..0410e43 100644 --- a/types/JoinTokenUserInfo.html +++ b/types/JoinTokenUserInfo.html @@ -1 +1 @@ -JoinTokenUserInfo | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenUserInfo

JoinTokenUserInfo: {
    name: string;
    user_id: string;
    is_admin: boolean;
    is_hidden: boolean;
    user_metadata?: JoinTokenUserMetadata;
}

Settings

Member Visibility
+JoinTokenUserInfo | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenUserInfo

JoinTokenUserInfo: {
    name: string;
    user_id: string;
    is_admin: boolean;
    is_hidden: boolean;
    user_metadata?: JoinTokenUserMetadata;
}

Settings

Member Visibility
diff --git a/types/JoinTokenUserMetadata.html b/types/JoinTokenUserMetadata.html index 07c1888..14f4b87 100644 --- a/types/JoinTokenUserMetadata.html +++ b/types/JoinTokenUserMetadata.html @@ -1 +1 @@ -JoinTokenUserMetadata | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenUserMetadata

JoinTokenUserMetadata: {
    profile_pic?: string;
    lock_settings?: LockSettingsParams;
}

Settings

Member Visibility
+JoinTokenUserMetadata | plugNmeet JS SDK - v1.4.0

Type Alias JoinTokenUserMetadata

JoinTokenUserMetadata: {
    profile_pic?: string;
    lock_settings?: LockSettingsParams;
}

Settings

Member Visibility
diff --git a/types/LockSettingsParams.html b/types/LockSettingsParams.html index 792490a..62a2584 100644 --- a/types/LockSettingsParams.html +++ b/types/LockSettingsParams.html @@ -1 +1 @@ -LockSettingsParams | plugNmeet JS SDK - v1.4.0

Type Alias LockSettingsParams

LockSettingsParams: {
    lock_microphone?: boolean;
    lock_webcam?: boolean;
    lock_screen_sharing?: boolean;
    lock_whiteboard?: boolean;
    lock_shared_notepad?: boolean;
    lock_chat?: boolean;
    lock_chat_send_message?: boolean;
    lock_chat_file_share?: boolean;
}

Settings

Member Visibility
+LockSettingsParams | plugNmeet JS SDK - v1.4.0

Type Alias LockSettingsParams

LockSettingsParams: {
    lock_microphone?: boolean;
    lock_webcam?: boolean;
    lock_screen_sharing?: boolean;
    lock_whiteboard?: boolean;
    lock_shared_notepad?: boolean;
    lock_chat?: boolean;
    lock_chat_send_message?: boolean;
    lock_chat_file_share?: boolean;
}

Settings

Member Visibility
diff --git a/types/ParticipantInfo.html b/types/ParticipantInfo.html index ed6faf0..c8554df 100644 --- a/types/ParticipantInfo.html +++ b/types/ParticipantInfo.html @@ -1 +1 @@ -ParticipantInfo | plugNmeet JS SDK - v1.4.0

Type Alias ParticipantInfo

ParticipantInfo: {
    sid: string;
    identity: string;
    state: string;
    metadata: string;
    joined_at: number;
    name: string;
    version: number;
    permission: any;
}

Settings

Member Visibility
+ParticipantInfo | plugNmeet JS SDK - v1.4.0

Type Alias ParticipantInfo

ParticipantInfo: {
    sid: string;
    identity: string;
    state: string;
    metadata: string;
    joined_at: number;
    name: string;
    version: number;
    permission: any;
}

Settings

Member Visibility
diff --git a/types/PastRoomInfo.html b/types/PastRoomInfo.html index a683a0a..8ffd062 100644 --- a/types/PastRoomInfo.html +++ b/types/PastRoomInfo.html @@ -1 +1 @@ -PastRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias PastRoomInfo

PastRoomInfo: {
    room_title: string;
    room_id: string;
    room_sid: string;
    joined_participants: number;
    webhook_url: string;
    created: string;
    ended: string;
    analytics_files_id: string;
}

Settings

Member Visibility
+PastRoomInfo | plugNmeet JS SDK - v1.4.0

Type Alias PastRoomInfo

PastRoomInfo: {
    room_title: string;
    room_id: string;
    room_sid: string;
    joined_participants: number;
    webhook_url: string;
    created: string;
    ended: string;
    analytics_files_id: string;
}

Settings

Member Visibility
diff --git a/types/PastRoomInfoResult.html b/types/PastRoomInfoResult.html index 2378cd7..fc0bcc4 100644 --- a/types/PastRoomInfoResult.html +++ b/types/PastRoomInfoResult.html @@ -1 +1 @@ -PastRoomInfoResult | plugNmeet JS SDK - v1.4.0

Type Alias PastRoomInfoResult

PastRoomInfoResult: {
    total_rooms: number;
    from: number;
    limit: number;
    order_by: string;
    rooms_list: PastRoomInfo[];
}

Settings

Member Visibility
+PastRoomInfoResult | plugNmeet JS SDK - v1.4.0

Type Alias PastRoomInfoResult

PastRoomInfoResult: {
    total_rooms: number;
    from: number;
    limit: number;
    order_by: string;
    rooms_list: PastRoomInfo[];
}

Settings

Member Visibility
diff --git a/types/RecordingDownloadTokenParams.html b/types/RecordingDownloadTokenParams.html index af09ec6..968312e 100644 --- a/types/RecordingDownloadTokenParams.html +++ b/types/RecordingDownloadTokenParams.html @@ -1 +1 @@ -RecordingDownloadTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias RecordingDownloadTokenParams

RecordingDownloadTokenParams: {
    record_id: string;
}

Settings

Member Visibility
+RecordingDownloadTokenParams | plugNmeet JS SDK - v1.4.0

Type Alias RecordingDownloadTokenParams

RecordingDownloadTokenParams: {
    record_id: string;
}

Settings

Member Visibility
diff --git a/types/RecordingDownloadTokenResponse.html b/types/RecordingDownloadTokenResponse.html index 94fd7fb..9bb327a 100644 --- a/types/RecordingDownloadTokenResponse.html +++ b/types/RecordingDownloadTokenResponse.html @@ -1 +1 @@ -RecordingDownloadTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias RecordingDownloadTokenResponse

RecordingDownloadTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
+RecordingDownloadTokenResponse | plugNmeet JS SDK - v1.4.0

Type Alias RecordingDownloadTokenResponse

RecordingDownloadTokenResponse: {
    status: boolean;
    msg: string;
    token?: string;
}

Settings

Member Visibility
diff --git a/types/RecordingFeaturesParams.html b/types/RecordingFeaturesParams.html index eee49a3..010da71 100644 --- a/types/RecordingFeaturesParams.html +++ b/types/RecordingFeaturesParams.html @@ -1 +1 @@ -RecordingFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias RecordingFeaturesParams

RecordingFeaturesParams: {
    is_allow: boolean;
    is_allow_cloud: boolean;
    is_allow_local: boolean;
    enable_auto_cloud_recording: boolean;
}

Settings

Member Visibility
+RecordingFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias RecordingFeaturesParams

RecordingFeaturesParams: {
    is_allow: boolean;
    is_allow_cloud: boolean;
    is_allow_local: boolean;
    enable_auto_cloud_recording: boolean;
}

Settings

Member Visibility
diff --git a/types/RecordingInfo.html b/types/RecordingInfo.html index f66cb6e..de06260 100644 --- a/types/RecordingInfo.html +++ b/types/RecordingInfo.html @@ -1 +1 @@ -RecordingInfo | plugNmeet JS SDK - v1.4.0

Type Alias RecordingInfo

RecordingInfo: {
    record_id: string;
    room_id: string;
    room_sid: string;
    file_path: string;
    file_size: number;
    creation_time: number;
    room_creation_time: number;
}

Settings

Member Visibility
+RecordingInfo | plugNmeet JS SDK - v1.4.0

Type Alias RecordingInfo

RecordingInfo: {
    record_id: string;
    room_id: string;
    room_sid: string;
    file_path: string;
    file_size: number;
    creation_time: number;
    room_creation_time: number;
}

Settings

Member Visibility
diff --git a/types/RooMetadata.html b/types/RooMetadata.html index 0cc8a75..215cca5 100644 --- a/types/RooMetadata.html +++ b/types/RooMetadata.html @@ -1 +1 @@ -RooMetadata | plugNmeet JS SDK - v1.4.0

Type Alias RooMetadata

RooMetadata: {
    room_title: string;
    welcome_message?: string;
    webhook_url?: string;
    logout_url?: string;
    room_features: RoomFeaturesParams;
    default_lock_settings?: LockSettingsParams;
    copyright_conf?: CopyrightConf;
    extra_data?: string;
}

Settings

Member Visibility
+RooMetadata | plugNmeet JS SDK - v1.4.0

Type Alias RooMetadata

RooMetadata: {
    room_title: string;
    welcome_message?: string;
    webhook_url?: string;
    logout_url?: string;
    room_features: RoomFeaturesParams;
    default_lock_settings?: LockSettingsParams;
    copyright_conf?: CopyrightConf;
    extra_data?: string;
}

Settings

Member Visibility
diff --git a/types/Room.html b/types/Room.html index 3a6896d..4297e5e 100644 --- a/types/Room.html +++ b/types/Room.html @@ -1 +1 @@ -Room | plugNmeet JS SDK - v1.4.0

Type Alias Room

Room: {
    room_info: ActiveRoomInfo;
    participants_info: ParticipantInfo[];
}

Settings

Member Visibility
+Room | plugNmeet JS SDK - v1.4.0

Type Alias Room

Room: {
    room_info: ActiveRoomInfo;
    participants_info: ParticipantInfo[];
}

Settings

Member Visibility
diff --git a/types/RoomFeaturesParams.html b/types/RoomFeaturesParams.html index 6b11a8c..90bb40b 100644 --- a/types/RoomFeaturesParams.html +++ b/types/RoomFeaturesParams.html @@ -1 +1 @@ -RoomFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias RoomFeaturesParams

RoomFeaturesParams: {
    allow_webcams: boolean;
    mute_on_start: boolean;
    allow_screen_share: boolean;
    allow_rtmp: boolean;
    admin_only_webcams: boolean;
    allow_view_other_webcams: boolean;
    allow_view_other_users_list: boolean;
    room_duration: number;
    enable_analytics: boolean;
    allow_virtual_bg: boolean;
    allow_raise_hand: boolean;
    recording_features: RecordingFeaturesParams;
    chat_features: ChatFeaturesParams;
    shared_note_pad_features?: SharedNotePadFeaturesParams;
    whiteboard_features?: WhiteboardFeaturesParams;
    external_media_player_features?: ExternalMediaPlayerFeatures;
    waiting_room_features?: WaitingRoomFeatures;
    breakout_room_features?: BreakoutRoomFeatures;
    display_external_link_features?: DisplayExternalLinkFeatures;
    ingress_features?: IngressFeatures;
    speech_to_text_translation_features?: SpeechToTextTranslationFeatures;
    end_to_end_encryption_features?: EndToEndEncryptionFeatures;
}

Settings

Member Visibility
+RoomFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias RoomFeaturesParams

RoomFeaturesParams: {
    allow_webcams: boolean;
    mute_on_start: boolean;
    allow_screen_share: boolean;
    allow_rtmp: boolean;
    admin_only_webcams: boolean;
    allow_view_other_webcams: boolean;
    allow_view_other_users_list: boolean;
    room_duration: number;
    enable_analytics: boolean;
    allow_virtual_bg: boolean;
    allow_raise_hand: boolean;
    recording_features: RecordingFeaturesParams;
    chat_features: ChatFeaturesParams;
    shared_note_pad_features?: SharedNotePadFeaturesParams;
    whiteboard_features?: WhiteboardFeaturesParams;
    external_media_player_features?: ExternalMediaPlayerFeatures;
    waiting_room_features?: WaitingRoomFeatures;
    breakout_room_features?: BreakoutRoomFeatures;
    display_external_link_features?: DisplayExternalLinkFeatures;
    ingress_features?: IngressFeatures;
    speech_to_text_translation_features?: SpeechToTextTranslationFeatures;
    end_to_end_encryption_features?: EndToEndEncryptionFeatures;
}

Settings

Member Visibility
diff --git a/types/SharedNotePadFeaturesParams.html b/types/SharedNotePadFeaturesParams.html index cb9bffa..f50ba22 100644 --- a/types/SharedNotePadFeaturesParams.html +++ b/types/SharedNotePadFeaturesParams.html @@ -1 +1 @@ -SharedNotePadFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias SharedNotePadFeaturesParams

SharedNotePadFeaturesParams: {
    allowed_shared_note_pad: boolean;
}

Settings

Member Visibility
+SharedNotePadFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias SharedNotePadFeaturesParams

SharedNotePadFeaturesParams: {
    allowed_shared_note_pad: boolean;
}

Settings

Member Visibility
diff --git a/types/SpeechToTextTranslationFeatures.html b/types/SpeechToTextTranslationFeatures.html index 8d19985..fea6b29 100644 --- a/types/SpeechToTextTranslationFeatures.html +++ b/types/SpeechToTextTranslationFeatures.html @@ -1 +1 @@ -SpeechToTextTranslationFeatures | plugNmeet JS SDK - v1.4.0

Type Alias SpeechToTextTranslationFeatures

SpeechToTextTranslationFeatures: {
    is_allow: boolean;
    is_allow_translation: boolean;
}

Settings

Member Visibility
+SpeechToTextTranslationFeatures | plugNmeet JS SDK - v1.4.0

Type Alias SpeechToTextTranslationFeatures

SpeechToTextTranslationFeatures: {
    is_allow: boolean;
    is_allow_translation: boolean;
}

Settings

Member Visibility
diff --git a/types/WaitingRoomFeatures.html b/types/WaitingRoomFeatures.html index 638769e..33dbc32 100644 --- a/types/WaitingRoomFeatures.html +++ b/types/WaitingRoomFeatures.html @@ -1 +1 @@ -WaitingRoomFeatures | plugNmeet JS SDK - v1.4.0

Type Alias WaitingRoomFeatures

WaitingRoomFeatures: {
    is_active: boolean;
    waiting_room_msg?: string;
}

Settings

Member Visibility
+WaitingRoomFeatures | plugNmeet JS SDK - v1.4.0

Type Alias WaitingRoomFeatures

WaitingRoomFeatures: {
    is_active: boolean;
    waiting_room_msg?: string;
}

Settings

Member Visibility
diff --git a/types/WhiteboardFeaturesParams.html b/types/WhiteboardFeaturesParams.html index 066b56e..897b1e0 100644 --- a/types/WhiteboardFeaturesParams.html +++ b/types/WhiteboardFeaturesParams.html @@ -1 +1 @@ -WhiteboardFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias WhiteboardFeaturesParams

WhiteboardFeaturesParams: {
    allowed_whiteboard: boolean;
    preload_file?: string;
}

Settings

Member Visibility
+WhiteboardFeaturesParams | plugNmeet JS SDK - v1.4.0

Type Alias WhiteboardFeaturesParams

WhiteboardFeaturesParams: {
    allowed_whiteboard: boolean;
    preload_file?: string;
}

Settings

Member Visibility