Documentation

UpdateParticipantRequest extends Message
in package

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

Table of Contents

Properties

$identity  : mixed
Generated from protobuf field <code>string identity = 2;</code>
$metadata  : mixed
metadata to update. skipping updates if left empty
$name  : mixed
display name to update
$permission  : mixed
set to update the participant's permissions
$room  : mixed
Generated from protobuf field <code>string room = 1;</code>
$attributes  : mixed
attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string

Methods

__construct()  : mixed
Constructor.
clearPermission()  : mixed
getAttributes()  : MapField
attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string
getIdentity()  : string
Generated from protobuf field <code>string identity = 2;</code>
getMetadata()  : string
metadata to update. skipping updates if left empty
getName()  : string
display name to update
getPermission()  : ParticipantPermission|null
set to update the participant's permissions
getRoom()  : string
Generated from protobuf field <code>string room = 1;</code>
hasPermission()  : mixed
setAttributes()  : $this
attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string
setIdentity()  : $this
Generated from protobuf field <code>string identity = 2;</code>
setMetadata()  : $this
metadata to update. skipping updates if left empty
setName()  : $this
display name to update
setPermission()  : $this
set to update the participant's permissions
setRoom()  : $this
Generated from protobuf field <code>string room = 1;</code>

Properties

$identity

Generated from protobuf field <code>string identity = 2;</code>

protected mixed $identity = ''

$metadata

metadata to update. skipping updates if left empty

protected mixed $metadata = ''

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$name

display name to update

protected mixed $name = ''

Generated from protobuf field string name = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$permission

set to update the participant's permissions

protected mixed $permission = null

Generated from protobuf field .livekit.ParticipantPermission permission = 4;

$attributes

attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string

private mixed $attributes

Generated from protobuf field map<string, string> attributes = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

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
@type string $identity
@type string $metadata
      metadata to update. skipping updates if left empty
@type \Livekit\ParticipantPermission $permission
      set to update the participant's permissions
@type string $name
      display name to update
@type array|\Google\Protobuf\Internal\MapField $attributes
      attributes to update. it only updates attributes that have been set
      to delete attributes, set the value to an empty string

}

getAttributes()

attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string

public getAttributes() : MapField

Generated from protobuf field map<string, string> attributes = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
MapField

getIdentity()

Generated from protobuf field <code>string identity = 2;</code>

public getIdentity() : string
Return values
string

getMetadata()

metadata to update. skipping updates if left empty

public getMetadata() : string

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getName()

display name to update

public getName() : string

Generated from protobuf field string name = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getRoom()

Generated from protobuf field <code>string room = 1;</code>

public getRoom() : string
Return values
string

setAttributes()

attributes to update. it only updates attributes that have been set to delete attributes, set the value to an empty string

public setAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> attributes = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setIdentity()

Generated from protobuf field <code>string identity = 2;</code>

public setIdentity(string $var) : $this
Parameters
$var : string
Return values
$this

setMetadata()

metadata to update. skipping updates if left empty

public setMetadata(string $var) : $this

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setName()

display name to update

public setName(string $var) : $this

Generated from protobuf field string name = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setRoom()

Generated from protobuf field <code>string room = 1;</code>

public setRoom(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results