Class PlugNmeet

Implements

PlugNmeetAPI

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 src/PlugNmeet.ts:90

Methods

createRoom

createRoom(params: CreateRoomReq): Promise<CreateRoomRes>
Create new room
Parameters
- params: CreateRoomReq
Returns Promise<CreateRoomRes>
Promise
Implementation of PlugNmeetAPI.createRoom
- Defined in src/PlugNmeet.ts:103

getJoinToken

getJoinToken(params: GenerateTokenReq): Promise<GenerateTokenRes>
Generate join token
Parameters
- params: GenerateTokenReq
Returns Promise<GenerateTokenRes>
Promise
Implementation of PlugNmeetAPI.getJoinToken
- Defined in src/PlugNmeet.ts:124

isRoomActive

isRoomActive(params: IsRoomActiveReq): Promise<IsRoomActiveRes>
If room is active or not
Parameters
- params: IsRoomActiveReq
Returns Promise<IsRoomActiveRes>
Promise
Implementation of PlugNmeetAPI.isRoomActive
- Defined in src/PlugNmeet.ts:147

getActiveRoomInfo

getActiveRoomInfo(params: GetActiveRoomInfoReq): Promise<GetActiveRoomInfoRes>
Get active room information
Parameters
- params: GetActiveRoomInfoReq
Returns Promise<GetActiveRoomInfoRes>
Promise
Implementation of PlugNmeetAPI.getActiveRoomInfo
- Defined in src/PlugNmeet.ts:168

getActiveRoomsInfo

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

Returns Promise<GetActiveRoomsInfoRes>
Promise
Implementation of PlugNmeetAPI.getActiveRoomsInfo
- Defined in src/PlugNmeet.ts:190

fetchPastRoomsInfo

fetchPastRoomsInfo(params: FetchPastRoomsReq): Promise<FetchPastRoomsRes>
Fetch info about past rooms
Parameters
- params: FetchPastRoomsReq
Returns Promise<FetchPastRoomsRes>
Promise
Implementation of PlugNmeetAPI.fetchPastRoomsInfo
- Defined in src/PlugNmeet.ts:210

endRoom

endRoom(params: RoomEndReq): Promise<RoomEndRes>
End active room
Parameters
- params: RoomEndReq
Returns Promise<RoomEndRes>
Promise
Implementation of PlugNmeetAPI.endRoom
- Defined in src/PlugNmeet.ts:233

broadcastToRoom

broadcastToRoom(params: BroadcastToRoomReq): Promise<CommonResponse>
Broadcast messages or notifications directly into an active Plug-N-Meet session in real-time.
Parameters
- params: BroadcastToRoomReq
Returns Promise<CommonResponse>
Promise
Implementation of PlugNmeetAPI.broadcastToRoom
- Defined in src/PlugNmeet.ts:254

uploadWhiteboardFile

uploadWhiteboardFile(params: UploadWhiteboardFileReq): Promise<CommonResponse>
Upload a file to be used on the whiteboard.
Parameters
- params: UploadWhiteboardFileReq
Returns Promise<CommonResponse>
Promise
Implementation of PlugNmeetAPI.uploadWhiteboardFile
- Defined in src/PlugNmeet.ts:277

fetchArtifacts

fetchArtifacts(params: FetchArtifactsReq): Promise<FetchArtifactsRes>
Fetch artifacts
Parameters
- params: FetchArtifactsReq
Returns Promise<FetchArtifactsRes>
Promise
Implementation of PlugNmeetAPI.fetchArtifacts
- Defined in src/PlugNmeet.ts:316

deleteArtifact

deleteArtifact(params: DeleteArtifactReq): Promise<DeleteArtifactRes>
Delete artifact
Parameters
- params: DeleteArtifactReq
Returns Promise<DeleteArtifactRes>
Promise
Implementation of PlugNmeetAPI.deleteArtifact
- Defined in src/PlugNmeet.ts:339

getArtifactDownloadToken

getArtifactDownloadToken(
params: GetArtifactDownloadTokenReq,
): Promise<GetArtifactDownloadTokenRes>
Generate token to download Artifact
Parameters
- params: GetArtifactDownloadTokenReq
Returns Promise<GetArtifactDownloadTokenRes>
Promise
Implementation of PlugNmeetAPI.getArtifactDownloadToken
- Defined in src/PlugNmeet.ts:362

getArtifactInfo

getArtifactInfo(params: ArtifactInfoReq): Promise<ArtifactInfoRes>
Get Artifact details
Parameters
- params: ArtifactInfoReq
Returns Promise<ArtifactInfoRes>
Promise
Implementation of PlugNmeetAPI.getArtifactInfo
- Defined in src/PlugNmeet.ts:385

fetchRecordings

fetchRecordings(params: FetchRecordingsReq): Promise<FetchRecordingsRes>
Fetch recordings
Parameters
- params: FetchRecordingsReq
Returns Promise<FetchRecordingsRes>
Promise
Implementation of PlugNmeetAPI.fetchRecordings
- Defined in src/PlugNmeet.ts:408

deleteRecordings

deleteRecordings(params: DeleteRecordingReq): Promise<DeleteRecordingRes>
Delete recording
Parameters
- params: DeleteRecordingReq
Returns Promise<DeleteRecordingRes>
Promise
Implementation of PlugNmeetAPI.deleteRecordings
- Defined in src/PlugNmeet.ts:431

getRecordingDownloadToken

getRecordingDownloadToken(
params: GetDownloadTokenReq,
): Promise<GetDownloadTokenRes>
Generate token to download recording
Parameters
- params: GetDownloadTokenReq
Returns Promise<GetDownloadTokenRes>
Promise
Implementation of PlugNmeetAPI.getRecordingDownloadToken
- Defined in src/PlugNmeet.ts:454

updateRecordingMetadata

updateRecordingMetadata(
params: UpdateRecordingMetadataReq,
): Promise<UpdateRecordingMetadataRes>
Update recording metadata info
Parameters
- params: UpdateRecordingMetadataReq
Returns Promise<UpdateRecordingMetadataRes>
Promise
Implementation of PlugNmeetAPI.updateRecordingMetadata
- Defined in src/PlugNmeet.ts:477

mergeRecordings

mergeRecordings(params: MergeRecordingsReq): Promise<CommonResponse>
Merge multiple parts of a session's recording into a single new recording.
Parameters
- params: MergeRecordingsReq
Returns Promise<CommonResponse>
Promise
Implementation of PlugNmeetAPI.mergeRecordings
- Defined in src/PlugNmeet.ts:500

getRecordingInfo

getRecordingInfo(params: RecordingInfoReq): Promise<RecordingInfoRes>
Get recording details
Parameters
- params: RecordingInfoReq
Returns Promise<RecordingInfoRes>
Promise
Implementation of PlugNmeetAPI.getRecordingInfo
- Defined in src/PlugNmeet.ts:523

getClientFiles

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

Returns Promise<GetClientFilesRes>
Promise
Implementation of PlugNmeetAPI.getClientFiles
- Defined in src/PlugNmeet.ts:545