Documentation

SIPDispatchRuleCallee extends Message
in package

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

Table of Contents

Properties

$pin  : mixed
Optional pin required to enter room
$randomize  : mixed
Optionally append random suffix
$room_prefix  : mixed
Prefix used on new room name

Methods

__construct()  : mixed
Constructor.
getPin()  : string
Optional pin required to enter room
getRandomize()  : bool
Optionally append random suffix
getRoomPrefix()  : string
Prefix used on new room name
setPin()  : $this
Optional pin required to enter room
setRandomize()  : $this
Optionally append random suffix
setRoomPrefix()  : $this
Prefix used on new room name

Properties

$pin

Optional pin required to enter room

protected mixed $pin = ''

Generated from protobuf field string pin = 2;

$randomize

Optionally append random suffix

protected mixed $randomize = false

Generated from protobuf field bool randomize = 3;

$room_prefix

Prefix used on new room name

protected mixed $room_prefix = ''

Generated from protobuf field string room_prefix = 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 $room_prefix
      Prefix used on new room name
@type string $pin
      Optional pin required to enter room
@type bool $randomize
      Optionally append random suffix

}

getPin()

Optional pin required to enter room

public getPin() : string

Generated from protobuf field string pin = 2;

Return values
string

getRandomize()

Optionally append random suffix

public getRandomize() : bool

Generated from protobuf field bool randomize = 3;

Return values
bool

getRoomPrefix()

Prefix used on new room name

public getRoomPrefix() : string

Generated from protobuf field string room_prefix = 1;

Return values
string

setPin()

Optional pin required to enter room

public setPin(string $var) : $this

Generated from protobuf field string pin = 2;

Parameters
$var : string
Return values
$this

setRandomize()

Optionally append random suffix

public setRandomize(bool $var) : $this

Generated from protobuf field bool randomize = 3;

Parameters
$var : bool
Return values
$this

setRoomPrefix()

Prefix used on new room name

public setRoomPrefix(string $var) : $this

Generated from protobuf field string room_prefix = 1;

Parameters
$var : string
Return values
$this

        
On this page

Search results