Documentation

ListUpdate extends Message
in package

ListUpdate is used for updated APIs where 'repeated string' field is modified.

Generated from protobuf message livekit.ListUpdate

Table of Contents

Properties

$clear  : mixed
sets the list to an empty list
$add  : mixed
append items to a list, avoiding duplicates
$remove  : mixed
delete items from a list
$set  : mixed
set the field to a new list

Methods

__construct()  : mixed
Constructor.
getAdd()  : RepeatedField<string|int, string>
append items to a list, avoiding duplicates
getClear()  : bool
sets the list to an empty list
getRemove()  : RepeatedField<string|int, string>
delete items from a list
getSet()  : RepeatedField<string|int, string>
set the field to a new list
setAdd()  : $this
append items to a list, avoiding duplicates
setClear()  : $this
sets the list to an empty list
setRemove()  : $this
delete items from a list
setSet()  : $this
set the field to a new list

Properties

$clear

sets the list to an empty list

protected mixed $clear = false

Generated from protobuf field bool clear = 4;

$add

append items to a list, avoiding duplicates

private mixed $add

Generated from protobuf field repeated string add = 2;

$remove

delete items from a list

private mixed $remove

Generated from protobuf field repeated string remove = 3;

$set

set the field to a new list

private mixed $set

Generated from protobuf field repeated string set = 1;

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[] $set
      set the field to a new list
@type string[] $add
      append items to a list, avoiding duplicates
@type string[] $remove
      delete items from a list
@type bool $clear
      sets the list to an empty list

}

getAdd()

append items to a list, avoiding duplicates

public getAdd() : RepeatedField<string|int, string>

Generated from protobuf field repeated string add = 2;

Return values
RepeatedField<string|int, string>

getClear()

sets the list to an empty list

public getClear() : bool

Generated from protobuf field bool clear = 4;

Return values
bool

getRemove()

delete items from a list

public getRemove() : RepeatedField<string|int, string>

Generated from protobuf field repeated string remove = 3;

Return values
RepeatedField<string|int, string>

getSet()

set the field to a new list

public getSet() : RepeatedField<string|int, string>

Generated from protobuf field repeated string set = 1;

Return values
RepeatedField<string|int, string>

setAdd()

append items to a list, avoiding duplicates

public setAdd(array<string|int, string> $var) : $this

Generated from protobuf field repeated string add = 2;

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

setClear()

sets the list to an empty list

public setClear(bool $var) : $this

Generated from protobuf field bool clear = 4;

Parameters
$var : bool
Return values
$this

setRemove()

delete items from a list

public setRemove(array<string|int, string> $var) : $this

Generated from protobuf field repeated string remove = 3;

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

setSet()

set the field to a new list

public setSet(array<string|int, string> $var) : $this

Generated from protobuf field repeated string set = 1;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results