diff --git a/classes/PlugNmeet.html b/classes/PlugNmeet.html index 4a6068c..b1411da 100644 --- a/classes/PlugNmeet.html +++ b/classes/PlugNmeet.html @@ -1,4 +1,4 @@ -PlugNmeet | plugNmeet JS SDK - v1.4.1

Class PlugNmeet

Implements

Constructors

constructor +PlugNmeet | plugNmeet JS SDK - v1.4.1

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 703bc38..5f8888a 100644 --- a/interfaces/PlugNmeetAPI.html +++ b/interfaces/PlugNmeetAPI.html @@ -1,4 +1,4 @@ -PlugNmeetAPI | plugNmeet JS SDK - v1.4.1

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.1

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 4d28b55..237dd63 100644 --- a/types/ActiveRoomInfo.html +++ b/types/ActiveRoomInfo.html @@ -1 +1 @@ -ActiveRoomInfo | plugNmeet JS SDK - v1.4.1

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.1

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 ac9b75d..1d06d86 100644 --- a/types/ActiveRoomInfoParams.html +++ b/types/ActiveRoomInfoParams.html @@ -1 +1 @@ -ActiveRoomInfoParams | plugNmeet JS SDK - v1.4.1

Type Alias ActiveRoomInfoParams

ActiveRoomInfoParams: {
    room_id: string;
}

Settings

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

Type Alias ActiveRoomInfoParams

ActiveRoomInfoParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/ActiveRoomInfoResponse.html b/types/ActiveRoomInfoResponse.html index 90c512c..cc1a06e 100644 --- a/types/ActiveRoomInfoResponse.html +++ b/types/ActiveRoomInfoResponse.html @@ -1 +1 @@ -ActiveRoomInfoResponse | plugNmeet JS SDK - v1.4.1

Type Alias ActiveRoomInfoResponse

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

Settings

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

Type Alias ActiveRoomInfoResponse

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

Settings

Member Visibility
diff --git a/types/ActiveRoomsInfoResponse.html b/types/ActiveRoomsInfoResponse.html index f757d58..5a8ef5b 100644 --- a/types/ActiveRoomsInfoResponse.html +++ b/types/ActiveRoomsInfoResponse.html @@ -1 +1 @@ -ActiveRoomsInfoResponse | plugNmeet JS SDK - v1.4.1

Type Alias ActiveRoomsInfoResponse

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

Settings

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

Type Alias ActiveRoomsInfoResponse

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

Settings

Member Visibility
diff --git a/types/AnalyticsDownloadTokenParams.html b/types/AnalyticsDownloadTokenParams.html index d779414..d22b7eb 100644 --- a/types/AnalyticsDownloadTokenParams.html +++ b/types/AnalyticsDownloadTokenParams.html @@ -1 +1 @@ -AnalyticsDownloadTokenParams | plugNmeet JS SDK - v1.4.1

Type Alias AnalyticsDownloadTokenParams

AnalyticsDownloadTokenParams: {
    file_id: string;
}

Settings

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

Type Alias AnalyticsDownloadTokenParams

AnalyticsDownloadTokenParams: {
    file_id: string;
}

Settings

Member Visibility
diff --git a/types/AnalyticsDownloadTokenResponse.html b/types/AnalyticsDownloadTokenResponse.html index a4b6683..d047858 100644 --- a/types/AnalyticsDownloadTokenResponse.html +++ b/types/AnalyticsDownloadTokenResponse.html @@ -1 +1 @@ -AnalyticsDownloadTokenResponse | plugNmeet JS SDK - v1.4.1

Type Alias AnalyticsDownloadTokenResponse

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

Settings

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

Type Alias AnalyticsDownloadTokenResponse

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

Settings

Member Visibility
diff --git a/types/AnalyticsInfo.html b/types/AnalyticsInfo.html index f98e0f0..fad0d51 100644 --- a/types/AnalyticsInfo.html +++ b/types/AnalyticsInfo.html @@ -1 +1 @@ -AnalyticsInfo | plugNmeet JS SDK - v1.4.1

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.1

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 abe6c72..bd87875 100644 --- a/types/BreakoutRoomFeatures.html +++ b/types/BreakoutRoomFeatures.html @@ -1 +1 @@ -BreakoutRoomFeatures | plugNmeet JS SDK - v1.4.1

Type Alias BreakoutRoomFeatures

BreakoutRoomFeatures: {
    is_allow: boolean;
}

Settings

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

Type Alias BreakoutRoomFeatures

BreakoutRoomFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/ChatFeaturesParams.html b/types/ChatFeaturesParams.html index 61cfe5d..7bf84e4 100644 --- a/types/ChatFeaturesParams.html +++ b/types/ChatFeaturesParams.html @@ -1 +1 @@ -ChatFeaturesParams | plugNmeet JS SDK - v1.4.1

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.1

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 6477fb6..2b12cc2 100644 --- a/types/ClientFilesResponse.html +++ b/types/ClientFilesResponse.html @@ -1 +1 @@ -ClientFilesResponse | plugNmeet JS SDK - v1.4.1

Type Alias ClientFilesResponse

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

Settings

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

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 45d88ee..8bfd1f7 100644 --- a/types/CreateRoomParams.html +++ b/types/CreateRoomParams.html @@ -1 +1 @@ -CreateRoomParams | plugNmeet JS SDK - v1.4.1

Type Alias CreateRoomParams

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

Settings

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

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 b3c673b..c8d6537 100644 --- a/types/CreateRoomResponse.html +++ b/types/CreateRoomResponse.html @@ -1 +1 @@ -CreateRoomResponse | plugNmeet JS SDK - v1.4.1

Type Alias CreateRoomResponse

CreateRoomResponse: {
    status: boolean;
    msg: string;
    room_info?: ActiveRoomInfo;
}

Settings

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

Type Alias CreateRoomResponse

CreateRoomResponse: {
    status: boolean;
    msg: string;
    room_info?: ActiveRoomInfo;
}

Settings

Member Visibility
diff --git a/types/DeleteAnalyticsParams.html b/types/DeleteAnalyticsParams.html index b7966eb..1352fde 100644 --- a/types/DeleteAnalyticsParams.html +++ b/types/DeleteAnalyticsParams.html @@ -1 +1 @@ -DeleteAnalyticsParams | plugNmeet JS SDK - v1.4.1

Type Alias DeleteAnalyticsParams

DeleteAnalyticsParams: {
    file_id: string;
}

Settings

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

Type Alias DeleteAnalyticsParams

DeleteAnalyticsParams: {
    file_id: string;
}

Settings

Member Visibility
diff --git a/types/DeleteAnalyticsResponse.html b/types/DeleteAnalyticsResponse.html index 775f4f4..353aa9b 100644 --- a/types/DeleteAnalyticsResponse.html +++ b/types/DeleteAnalyticsResponse.html @@ -1 +1 @@ -DeleteAnalyticsResponse | plugNmeet JS SDK - v1.4.1

Type Alias DeleteAnalyticsResponse

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

Settings

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

Type Alias DeleteAnalyticsResponse

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

Settings

Member Visibility
diff --git a/types/DeleteRecordingsParams.html b/types/DeleteRecordingsParams.html index b117db0..d30ab65 100644 --- a/types/DeleteRecordingsParams.html +++ b/types/DeleteRecordingsParams.html @@ -1 +1 @@ -DeleteRecordingsParams | plugNmeet JS SDK - v1.4.1

Type Alias DeleteRecordingsParams

DeleteRecordingsParams: {
    record_id: string;
}

Settings

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

Type Alias DeleteRecordingsParams

DeleteRecordingsParams: {
    record_id: string;
}

Settings

Member Visibility
diff --git a/types/DeleteRecordingsResponse.html b/types/DeleteRecordingsResponse.html index f0f2f92..f9a66c9 100644 --- a/types/DeleteRecordingsResponse.html +++ b/types/DeleteRecordingsResponse.html @@ -1 +1 @@ -DeleteRecordingsResponse | plugNmeet JS SDK - v1.4.1

Type Alias DeleteRecordingsResponse

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

Settings

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

Type Alias DeleteRecordingsResponse

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

Settings

Member Visibility
diff --git a/types/DisplayExternalLinkFeatures.html b/types/DisplayExternalLinkFeatures.html index 7a6fbfd..17f5daf 100644 --- a/types/DisplayExternalLinkFeatures.html +++ b/types/DisplayExternalLinkFeatures.html @@ -1 +1 @@ -DisplayExternalLinkFeatures | plugNmeet JS SDK - v1.4.1

Type Alias DisplayExternalLinkFeatures

DisplayExternalLinkFeatures: {
    is_allow: boolean;
}

Settings

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

Type Alias DisplayExternalLinkFeatures

DisplayExternalLinkFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/EndRoomParams.html b/types/EndRoomParams.html index aa999cb..eae2e7e 100644 --- a/types/EndRoomParams.html +++ b/types/EndRoomParams.html @@ -1 +1 @@ -EndRoomParams | plugNmeet JS SDK - v1.4.1

Type Alias EndRoomParams

EndRoomParams: {
    room_id: string;
}

Settings

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

Type Alias EndRoomParams

EndRoomParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/EndRoomResponse.html b/types/EndRoomResponse.html index bd9a6c2..2cb2c23 100644 --- a/types/EndRoomResponse.html +++ b/types/EndRoomResponse.html @@ -1 +1 @@ -EndRoomResponse | plugNmeet JS SDK - v1.4.1

Type Alias EndRoomResponse

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

Settings

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

Type Alias EndRoomResponse

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

Settings

Member Visibility
diff --git a/types/EndToEndEncryptionFeatures.html b/types/EndToEndEncryptionFeatures.html index 67a91cd..6811536 100644 --- a/types/EndToEndEncryptionFeatures.html +++ b/types/EndToEndEncryptionFeatures.html @@ -1 +1 @@ -EndToEndEncryptionFeatures | plugNmeet JS SDK - v1.4.1

Type Alias EndToEndEncryptionFeatures

EndToEndEncryptionFeatures: {
    is_enabled: boolean;
    included_chat_messages?: boolean;
    included_whiteboard?: boolean;
}

Settings

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

Type Alias EndToEndEncryptionFeatures

EndToEndEncryptionFeatures: {
    is_enabled: boolean;
    included_chat_messages?: boolean;
    included_whiteboard?: boolean;
}

Settings

Member Visibility
diff --git a/types/ExternalMediaPlayerFeatures.html b/types/ExternalMediaPlayerFeatures.html index a57ec1e..25d438b 100644 --- a/types/ExternalMediaPlayerFeatures.html +++ b/types/ExternalMediaPlayerFeatures.html @@ -1 +1 @@ -ExternalMediaPlayerFeatures | plugNmeet JS SDK - v1.4.1

Type Alias ExternalMediaPlayerFeatures

ExternalMediaPlayerFeatures: {
    allowed_external_media_player: boolean;
}

Settings

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

Type Alias ExternalMediaPlayerFeatures

ExternalMediaPlayerFeatures: {
    allowed_external_media_player: boolean;
}

Settings

Member Visibility
diff --git a/types/FetchAnalyticsParams.html b/types/FetchAnalyticsParams.html index 9fc6294..424db4e 100644 --- a/types/FetchAnalyticsParams.html +++ b/types/FetchAnalyticsParams.html @@ -1 +1 @@ -FetchAnalyticsParams | plugNmeet JS SDK - v1.4.1

Type Alias FetchAnalyticsParams

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

Settings

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

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 542fcd3..fc727cb 100644 --- a/types/FetchAnalyticsResponse.html +++ b/types/FetchAnalyticsResponse.html @@ -1 +1 @@ -FetchAnalyticsResponse | plugNmeet JS SDK - v1.4.1

Type Alias FetchAnalyticsResponse

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

Settings

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

Type Alias FetchAnalyticsResponse

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

Settings

Member Visibility
diff --git a/types/FetchAnalyticsResult.html b/types/FetchAnalyticsResult.html index fd352c0..3243bdd 100644 --- a/types/FetchAnalyticsResult.html +++ b/types/FetchAnalyticsResult.html @@ -1 +1 @@ -FetchAnalyticsResult | plugNmeet JS SDK - v1.4.1

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.1

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 031fc1a..7e234cd 100644 --- a/types/FetchPastRoomsInfoParams.html +++ b/types/FetchPastRoomsInfoParams.html @@ -1 +1 @@ -FetchPastRoomsInfoParams | plugNmeet JS SDK - v1.4.1

Type Alias FetchPastRoomsInfoParams

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

Settings

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

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 44b8691..f0990de 100644 --- a/types/FetchRecordingsParams.html +++ b/types/FetchRecordingsParams.html @@ -1 +1 @@ -FetchRecordingsParams | plugNmeet JS SDK - v1.4.1

Type Alias FetchRecordingsParams

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

Settings

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

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 a968b1d..b5001c8 100644 --- a/types/FetchRecordingsResponse.html +++ b/types/FetchRecordingsResponse.html @@ -1 +1 @@ -FetchRecordingsResponse | plugNmeet JS SDK - v1.4.1

Type Alias FetchRecordingsResponse

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

Settings

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

Type Alias FetchRecordingsResponse

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

Settings

Member Visibility
diff --git a/types/FetchRecordingsResult.html b/types/FetchRecordingsResult.html index f168eb4..4c2eb68 100644 --- a/types/FetchRecordingsResult.html +++ b/types/FetchRecordingsResult.html @@ -1 +1 @@ -FetchRecordingsResult | plugNmeet JS SDK - v1.4.1

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.1

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 b6c6dad..eb9e408 100644 --- a/types/FetchRoomsInfoResponse.html +++ b/types/FetchRoomsInfoResponse.html @@ -1 +1 @@ -FetchRoomsInfoResponse | plugNmeet JS SDK - v1.4.1

Type Alias FetchRoomsInfoResponse

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

Settings

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

Type Alias FetchRoomsInfoResponse

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

Settings

Member Visibility
diff --git a/types/IngressFeatures.html b/types/IngressFeatures.html index b02cfae..b8293eb 100644 --- a/types/IngressFeatures.html +++ b/types/IngressFeatures.html @@ -1 +1 @@ -IngressFeatures | plugNmeet JS SDK - v1.4.1

Type Alias IngressFeatures

IngressFeatures: {
    is_allow: boolean;
}

Settings

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

Type Alias IngressFeatures

IngressFeatures: {
    is_allow: boolean;
}

Settings

Member Visibility
diff --git a/types/IsRoomActiveParams.html b/types/IsRoomActiveParams.html index 79b8771..e3580a0 100644 --- a/types/IsRoomActiveParams.html +++ b/types/IsRoomActiveParams.html @@ -1 +1 @@ -IsRoomActiveParams | plugNmeet JS SDK - v1.4.1

Type Alias IsRoomActiveParams

IsRoomActiveParams: {
    room_id: string;
}

Settings

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

Type Alias IsRoomActiveParams

IsRoomActiveParams: {
    room_id: string;
}

Settings

Member Visibility
diff --git a/types/IsRoomActiveResponse.html b/types/IsRoomActiveResponse.html index 7193396..44a542d 100644 --- a/types/IsRoomActiveResponse.html +++ b/types/IsRoomActiveResponse.html @@ -1 +1 @@ -IsRoomActiveResponse | plugNmeet JS SDK - v1.4.1

Type Alias IsRoomActiveResponse

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

Settings

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

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 e2dd301..586858f 100644 --- a/types/JoinTokenParams.html +++ b/types/JoinTokenParams.html @@ -1 +1 @@ -JoinTokenParams | plugNmeet JS SDK - v1.4.1

Type Alias JoinTokenParams

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

Settings

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

Type Alias JoinTokenParams

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

Settings

Member Visibility
diff --git a/types/JoinTokenResponse.html b/types/JoinTokenResponse.html index 114f198..d0cffc2 100644 --- a/types/JoinTokenResponse.html +++ b/types/JoinTokenResponse.html @@ -1 +1 @@ -JoinTokenResponse | plugNmeet JS SDK - v1.4.1

Type Alias JoinTokenResponse

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

Settings

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

Type Alias JoinTokenResponse

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

Settings

Member Visibility
diff --git a/types/JoinTokenUserInfo.html b/types/JoinTokenUserInfo.html index c3ece37..340f3dd 100644 --- a/types/JoinTokenUserInfo.html +++ b/types/JoinTokenUserInfo.html @@ -1 +1 @@ -JoinTokenUserInfo | plugNmeet JS SDK - v1.4.1

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.1

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 31d41c6..c382ab6 100644 --- a/types/JoinTokenUserMetadata.html +++ b/types/JoinTokenUserMetadata.html @@ -1 +1 @@ -JoinTokenUserMetadata | plugNmeet JS SDK - v1.4.1

Type Alias JoinTokenUserMetadata

JoinTokenUserMetadata: {
    profile_pic?: string;
    record_webcam?: boolean;
    preferred_lang?: string;
    ex_user_id?: string;
    extra_data?: string;
    lock_settings?: LockSettingsParams;
}

Settings

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

Type Alias JoinTokenUserMetadata

JoinTokenUserMetadata: {
    profile_pic?: string;
    record_webcam?: boolean;
    preferred_lang?: string;
    ex_user_id?: string;
    extra_data?: string;
    lock_settings?: LockSettingsParams;
}

Settings

Member Visibility
diff --git a/types/LockSettingsParams.html b/types/LockSettingsParams.html index f2f740f..4aaafa5 100644 --- a/types/LockSettingsParams.html +++ b/types/LockSettingsParams.html @@ -1 +1 @@ -LockSettingsParams | plugNmeet JS SDK - v1.4.1

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.1

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 0fd2807..6281b88 100644 --- a/types/ParticipantInfo.html +++ b/types/ParticipantInfo.html @@ -1 +1 @@ -ParticipantInfo | plugNmeet JS SDK - v1.4.1

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.1

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 bb1d2b1..285991b 100644 --- a/types/PastRoomInfo.html +++ b/types/PastRoomInfo.html @@ -1 +1 @@ -PastRoomInfo | plugNmeet JS SDK - v1.4.1

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.1

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 fd9e368..809dace 100644 --- a/types/PastRoomInfoResult.html +++ b/types/PastRoomInfoResult.html @@ -1 +1 @@ -PastRoomInfoResult | plugNmeet JS SDK - v1.4.1

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.1

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 c956074..3e030e3 100644 --- a/types/RecordingDownloadTokenParams.html +++ b/types/RecordingDownloadTokenParams.html @@ -1 +1 @@ -RecordingDownloadTokenParams | plugNmeet JS SDK - v1.4.1

Type Alias RecordingDownloadTokenParams

RecordingDownloadTokenParams: {
    record_id: string;
}

Settings

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

Type Alias RecordingDownloadTokenParams

RecordingDownloadTokenParams: {
    record_id: string;
}

Settings

Member Visibility
diff --git a/types/RecordingDownloadTokenResponse.html b/types/RecordingDownloadTokenResponse.html index 0d0ca5a..a426280 100644 --- a/types/RecordingDownloadTokenResponse.html +++ b/types/RecordingDownloadTokenResponse.html @@ -1 +1 @@ -RecordingDownloadTokenResponse | plugNmeet JS SDK - v1.4.1

Type Alias RecordingDownloadTokenResponse

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

Settings

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

Type Alias RecordingDownloadTokenResponse

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

Settings

Member Visibility
diff --git a/types/RecordingFeaturesParams.html b/types/RecordingFeaturesParams.html index acb4e0b..fe96e56 100644 --- a/types/RecordingFeaturesParams.html +++ b/types/RecordingFeaturesParams.html @@ -1 +1 @@ -RecordingFeaturesParams | plugNmeet JS SDK - v1.4.1

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.1

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 e3eb113..972f92c 100644 --- a/types/RecordingInfo.html +++ b/types/RecordingInfo.html @@ -1 +1 @@ -RecordingInfo | plugNmeet JS SDK - v1.4.1

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.1

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 6d0f34a..786785e 100644 --- a/types/RooMetadata.html +++ b/types/RooMetadata.html @@ -1 +1 @@ -RooMetadata | plugNmeet JS SDK - v1.4.1

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.1

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 ddc7b5e..e300c79 100644 --- a/types/Room.html +++ b/types/Room.html @@ -1 +1 @@ -Room | plugNmeet JS SDK - v1.4.1

Type Alias Room

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

Settings

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

Type Alias Room

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

Settings

Member Visibility
diff --git a/types/RoomFeaturesParams.html b/types/RoomFeaturesParams.html index f11a8cc..648e5d9 100644 --- a/types/RoomFeaturesParams.html +++ b/types/RoomFeaturesParams.html @@ -1 +1 @@ -RoomFeaturesParams | plugNmeet JS SDK - v1.4.1

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;
    auto_gen_user_id?: 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.1

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;
    auto_gen_user_id?: 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 c7b0b95..d39b702 100644 --- a/types/SharedNotePadFeaturesParams.html +++ b/types/SharedNotePadFeaturesParams.html @@ -1 +1 @@ -SharedNotePadFeaturesParams | plugNmeet JS SDK - v1.4.1

Type Alias SharedNotePadFeaturesParams

SharedNotePadFeaturesParams: {
    allowed_shared_note_pad: boolean;
}

Settings

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

Type Alias SharedNotePadFeaturesParams

SharedNotePadFeaturesParams: {
    allowed_shared_note_pad: boolean;
}

Settings

Member Visibility
diff --git a/types/SpeechToTextTranslationFeatures.html b/types/SpeechToTextTranslationFeatures.html index 22052ba..546f883 100644 --- a/types/SpeechToTextTranslationFeatures.html +++ b/types/SpeechToTextTranslationFeatures.html @@ -1 +1 @@ -SpeechToTextTranslationFeatures | plugNmeet JS SDK - v1.4.1

Type Alias SpeechToTextTranslationFeatures

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

Settings

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

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 7eb1e16..e9ccba0 100644 --- a/types/WaitingRoomFeatures.html +++ b/types/WaitingRoomFeatures.html @@ -1 +1 @@ -WaitingRoomFeatures | plugNmeet JS SDK - v1.4.1

Type Alias WaitingRoomFeatures

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

Settings

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

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 01255d1..c2c873d 100644 --- a/types/WhiteboardFeaturesParams.html +++ b/types/WhiteboardFeaturesParams.html @@ -1 +1 @@ -WhiteboardFeaturesParams | plugNmeet JS SDK - v1.4.1

Type Alias WhiteboardFeaturesParams

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

Settings

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

Type Alias WhiteboardFeaturesParams

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

Settings

Member Visibility