Documentation

RoomParticipantIdentity extends Message
in package

Generated from protobuf message <code>livekit.RoomParticipantIdentity</code>

Table of Contents

Properties

$identity  : mixed
identity of the participant
$revoke_token_ts  : mixed
Unix timestamp used to invalidate token whose nbf is before this value.
$room  : mixed
name of the room

Methods

__construct()  : mixed
Constructor.
getIdentity()  : string
identity of the participant
getRevokeTokenTs()  : int|string
Unix timestamp used to invalidate token whose nbf is before this value.
getRoom()  : string
name of the room
setIdentity()  : $this
identity of the participant
setRevokeTokenTs()  : $this
Unix timestamp used to invalidate token whose nbf is before this value.
setRoom()  : $this
name of the room

Properties

$identity

identity of the participant

protected mixed $identity = ''

Generated from protobuf field string identity = 2;

$revoke_token_ts

Unix timestamp used to invalidate token whose nbf is before this value.

protected mixed $revoke_token_ts = 0

Used only by RemoveParticipant; defaults to now(server)+leeway(1min) if left empty.

Generated from protobuf field int64 revoke_token_ts = 3;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $room
      name of the room
@type string $identity
      identity of the participant
@type int|string $revoke_token_ts
      Unix timestamp used to invalidate token whose nbf is before this value.
      Used only by RemoveParticipant; defaults to now(server)+leeway(1min) if left empty.

}

getIdentity()

identity of the participant

public getIdentity() : string

Generated from protobuf field string identity = 2;

Return values
string

getRevokeTokenTs()

Unix timestamp used to invalidate token whose nbf is before this value.

public getRevokeTokenTs() : int|string

Used only by RemoveParticipant; defaults to now(server)+leeway(1min) if left empty.

Generated from protobuf field int64 revoke_token_ts = 3;

Return values
int|string

getRoom()

name of the room

public getRoom() : string

Generated from protobuf field string room = 1;

Return values
string

setIdentity()

identity of the participant

public setIdentity(string $var) : $this

Generated from protobuf field string identity = 2;

Parameters
$var : string
Return values
$this

setRevokeTokenTs()

Unix timestamp used to invalidate token whose nbf is before this value.

public setRevokeTokenTs(int|string $var) : $this

Used only by RemoveParticipant; defaults to now(server)+leeway(1min) if left empty.

Generated from protobuf field int64 revoke_token_ts = 3;

Parameters
$var : int|string
Return values
$this

setRoom()

name of the room

public setRoom(string $var) : $this

Generated from protobuf field string room = 1;

Parameters
$var : string
Return values
$this
On this page

Search results