Documentation

PlugNmeet
in package

Table of Contents

Properties

$algo  : string
$apiKey  : string
$apiSecret  : string
$defaultPath  : string
$guzzleClient  : Client
$serverUrl  : string

Methods

__construct()  : mixed
createRoom()  : CreateRoomRes
Create new room
decodeJWTData()  : stdClass
deleteAnalytics()  : DeleteAnalyticsRes
Deprecated: To delete analytics
deleteArtifact()  : DeleteArtifactRes
To delete artifact
deleteRecordings()  : DeleteRecordingRes
To delete recording
endRoom()  : RoomEndRes
End active room
fetchAnalytics()  : FetchAnalyticsRes
Deprecated: To fetch analytics
fetchArtifacts()  : FetchArtifactsRes
To fetch artifacts list
fetchPastRoomsInfo()  : FetchPastRoomsRes
Get all past rooms
fetchRecordings()  : FetchRecordingsRes
To fetch recordings
generateUuid4()  : string
Generate UUID v4 random string
getActiveRoomInfo()  : GetActiveRoomInfoRes
Get active room information
getActiveRoomsInfo()  : GetActiveRoomsInfoRes
Get all active rooms
getAnalyticsDownloadToken()  : GetAnalyticsDownloadTokenRes
Deprecated: Generate token to download analytics
getArtifactDownloadToken()  : GetArtifactDownloadTokenRes
Generate token to download artifact file
getArtifactInfo()  : ArtifactInfoRes
To get details of an artifact
getClientFiles()  : GetClientFilesRes
getJoinToken()  : GenerateTokenRes
Generate join token
getJWTencodedData()  : string
getRecordingDownloadToken()  : GetDownloadTokenRes
Generate token to download recording
getRecordingInfo()  : RecordingInfoRes
To get recording info
getUUID()  : string
Generate UUID random string
isRoomActive()  : IsRoomActiveRes
To check if room is active or not
updateRecordingMetadata()  : UpdateRecordingMetadataRes
To update recording metadata
sendRequest()  : stdClass
handleRequestException()  : mixed|string
Extracts a meaningful error response from a RequestException.

Properties

$defaultPath

protected string $defaultPath = "/auth"

$guzzleClient

protected Client $guzzleClient

Methods

__construct()

public __construct(string $serverUrl, string $apiKey, string $apiSecret[, int $timeout = 60 ][, bool $verifySSL = true ]) : mixed
Parameters
$serverUrl : string

plugNmeet server URL

$apiKey : string

plugNmeet API_Key

$apiSecret : string

plugNmeet API_Secret

$timeout : int = 60
$verifySSL : bool = true

decodeJWTData()

public decodeJWTData(string $raw[, string $algo = "HS256" ]) : stdClass
Parameters
$raw : string
$algo : string = "HS256"
Return values
stdClass

generateUuid4()

Generate UUID v4 random string

public static generateUuid4() : string
Return values
string

getJWTencodedData()

public getJWTencodedData(array<string|int, mixed> $payload, int $validity[, string $algo = "HS256" ][, array<string|int, mixed> $head = [] ]) : string
Parameters
$payload : array<string|int, mixed>
$validity : int

in seconds

$algo : string = "HS256"
$head : array<string|int, mixed> = []
Return values
string

getUUID()

Generate UUID random string

public getUUID() : string
Return values
string

sendRequest()

protected sendRequest(mixed $path, string $body) : stdClass
Parameters
$path : mixed
$body : string
Return values
stdClass

handleRequestException()

Extracts a meaningful error response from a RequestException.

private handleRequestException(RequestException $e) : mixed|string
Parameters
$e : RequestException
Return values
mixed|string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results