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

PlugNmeet

Index

Methods

createRoom getJoinToken isRoomActive getActiveRoomInfo getActiveRoomsInfo fetchPastRoomsInfo endRoom fetchAnalytics deleteAnalytics getAnalyticsDownloadToken fetchRecordings deleteRecordings getRecordingDownloadToken getClientFiles

Methods

createRoom

createRoom(params: CreateRoomParams): Promise<CreateRoomResponse>
Create new room
Parameters
- params: CreateRoomParams
Returns Promise<CreateRoomResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:40

getJoinToken

getJoinToken(params: JoinTokenParams): Promise<JoinTokenResponse>
Generate join token
Parameters
- params: JoinTokenParams
Returns Promise<JoinTokenResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:46

isRoomActive

isRoomActive(params: IsRoomActiveParams): Promise<IsRoomActiveResponse>
If room is active or not
Parameters
- params: IsRoomActiveParams
Returns Promise<IsRoomActiveResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:52

getActiveRoomInfo

getActiveRoomInfo(params: ActiveRoomInfoParams): Promise<ActiveRoomInfoResponse>
Get active room information
Parameters
- params: ActiveRoomInfoParams
Returns Promise<ActiveRoomInfoResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:58

getActiveRoomsInfo

getActiveRoomsInfo(): Promise<ActiveRoomsInfoResponse>
Get all active rooms

Returns Promise<ActiveRoomsInfoResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:65

fetchPastRoomsInfo

fetchPastRoomsInfo(
params: FetchPastRoomsInfoParams,
): Promise<FetchRoomsInfoResponse>
Fetch info about past rooms
Parameters
- params: FetchPastRoomsInfoParams
Returns Promise<FetchRoomsInfoResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:71

endRoom

endRoom(params: EndRoomParams): Promise<EndRoomResponse>
End active room
Parameters
- params: EndRoomParams
Returns Promise<EndRoomResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:79

fetchAnalytics

fetchAnalytics(params: FetchAnalyticsParams): Promise<FetchAnalyticsResponse>
Fetch analytics
Parameters
- params: FetchAnalyticsParams
Returns Promise<FetchAnalyticsResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:85

deleteAnalytics

deleteAnalytics(params: DeleteAnalyticsParams): Promise<DeleteAnalyticsResponse>
Delete analytics
Parameters
- params: DeleteAnalyticsParams
Returns Promise<DeleteAnalyticsResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:91

getAnalyticsDownloadToken

getAnalyticsDownloadToken(
params: AnalyticsDownloadTokenParams,
): Promise<AnalyticsDownloadTokenResponse>
Generate token to download recording
Parameters
- params: AnalyticsDownloadTokenParams
Returns Promise<AnalyticsDownloadTokenResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:99

fetchRecordings

fetchRecordings(params: FetchRecordingsParams): Promise<FetchRecordingsResponse>
Fetch recordings
Parameters
- params: FetchRecordingsParams
Returns Promise<FetchRecordingsResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:107

deleteRecordings

deleteRecordings(
params: DeleteRecordingsParams,
): Promise<DeleteRecordingsResponse>
Delete recording
Parameters
- params: DeleteRecordingsParams
Returns Promise<DeleteRecordingsResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:115

getRecordingDownloadToken

getRecordingDownloadToken(
params: RecordingDownloadTokenParams,
): Promise<RecordingDownloadTokenResponse>
Generate token to download recording
Parameters
- params: RecordingDownloadTokenParams
Returns Promise<RecordingDownloadTokenResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:123

getClientFiles

getClientFiles(): Promise<ClientFilesResponse>
To get JS & CSS files to build interface

Returns Promise<ClientFilesResponse>
Promise
- Defined in types/PlugNmeetAPI.ts:131