Class PlugNmeet

Implements

PlugNmeetAPI

Index

Constructors

Methods

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

Constructors

constructor

new PlugNmeet(serverUrl: string, apiKey: string, apiSecret: string): PlugNmeet
Parameters
- serverUrl: string
  plugNmeet server URL
- apiKey: string
  plugNmeet API_Key
- apiSecret: string
  plugNmeet API_Secret
Returns PlugNmeet
- Defined in PlugNmeet.ts:51

Methods

createRoom

createRoom(params: CreateRoomParams): Promise<CreateRoomResponse>
Create new room
Parameters
- params: CreateRoomParams
Returns Promise<CreateRoomResponse>
Promise
Implementation of PlugNmeetAPI.createRoom
- Defined in PlugNmeet.ts:64

getJoinToken

getJoinToken(params: JoinTokenParams): Promise<JoinTokenResponse>
Generate join token
Parameters
- params: JoinTokenParams
Returns Promise<JoinTokenResponse>
Promise
Implementation of PlugNmeetAPI.getJoinToken
- Defined in PlugNmeet.ts:87

isRoomActive

isRoomActive(params: IsRoomActiveParams): Promise<IsRoomActiveResponse>
If room is active or not
Parameters
- params: IsRoomActiveParams
Returns Promise<IsRoomActiveResponse>
Promise
Implementation of PlugNmeetAPI.isRoomActive
- Defined in PlugNmeet.ts:113

getActiveRoomInfo

getActiveRoomInfo(params: ActiveRoomInfoParams): Promise<ActiveRoomInfoResponse>
Get active room information
Parameters
- params: ActiveRoomInfoParams
Returns Promise<ActiveRoomInfoResponse>
Promise
Implementation of PlugNmeetAPI.getActiveRoomInfo
- Defined in PlugNmeet.ts:139

getActiveRoomsInfo

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

Returns Promise<ActiveRoomsInfoResponse>
Promise
Implementation of PlugNmeetAPI.getActiveRoomsInfo
- Defined in PlugNmeet.ts:164

fetchPastRoomsInfo

fetchPastRoomsInfo(
params: FetchPastRoomsInfoParams,
): Promise<FetchRoomsInfoResponse>
Fetch info about past rooms
Parameters
- params: FetchPastRoomsInfoParams
Returns Promise<FetchRoomsInfoResponse>
Promise
Implementation of PlugNmeetAPI.fetchPastRoomsInfo
- Defined in PlugNmeet.ts:188

endRoom

endRoom(params: EndRoomParams): Promise<EndRoomResponse>
End active room
Parameters
- params: EndRoomParams
Returns Promise<EndRoomResponse>
Promise
Implementation of PlugNmeetAPI.endRoom
- Defined in PlugNmeet.ts:214

fetchAnalytics

fetchAnalytics(params: FetchAnalyticsParams): Promise<FetchAnalyticsResponse>
Fetch analytics
Parameters
- params: FetchAnalyticsParams
Returns Promise<FetchAnalyticsResponse>
Promise
Implementation of PlugNmeetAPI.fetchAnalytics
- Defined in PlugNmeet.ts:234

deleteAnalytics

deleteAnalytics(params: DeleteAnalyticsParams): Promise<DeleteAnalyticsResponse>
Delete analytics
Parameters
- params: DeleteAnalyticsParams
Returns Promise<DeleteAnalyticsResponse>
Promise
Implementation of PlugNmeetAPI.deleteAnalytics
- Defined in PlugNmeet.ts:260

getAnalyticsDownloadToken

getAnalyticsDownloadToken(
params: AnalyticsDownloadTokenParams,
): Promise<AnalyticsDownloadTokenResponse>
Generate token to download recording
Parameters
- params: AnalyticsDownloadTokenParams
Returns Promise<AnalyticsDownloadTokenResponse>
Promise
Implementation of PlugNmeetAPI.getAnalyticsDownloadToken
- Defined in PlugNmeet.ts:285

fetchRecordings

fetchRecordings(params: FetchRecordingsParams): Promise<FetchRecordingsResponse>
Fetch recordings
Parameters
- params: FetchRecordingsParams
Returns Promise<FetchRecordingsResponse>
Promise
Implementation of PlugNmeetAPI.fetchRecordings
- Defined in PlugNmeet.ts:311

deleteRecordings

deleteRecordings(
params: DeleteRecordingsParams,
): Promise<DeleteRecordingsResponse>
Delete recording
Parameters
- params: DeleteRecordingsParams
Returns Promise<DeleteRecordingsResponse>
Promise
Implementation of PlugNmeetAPI.deleteRecordings
- Defined in PlugNmeet.ts:337

getRecordingDownloadToken

getRecordingDownloadToken(
params: RecordingDownloadTokenParams,
): Promise<RecordingDownloadTokenResponse>
Generate token to download recording
Parameters
- params: RecordingDownloadTokenParams
Returns Promise<RecordingDownloadTokenResponse>
Promise
Implementation of PlugNmeetAPI.getRecordingDownloadToken
- Defined in PlugNmeet.ts:362

getClientFiles

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

Returns Promise<ClientFilesResponse>
Promise
Implementation of PlugNmeetAPI.getClientFiles
- Defined in PlugNmeet.ts:387