Documentation

TransferSIPParticipantRequest extends Message
in package

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

Table of Contents

Properties

$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 1;</code>
$play_dialtone  : mixed
Optionally play dialtone to the SIP participant as an audible indicator of being transferred
$ringing_timeout  : mixed
Max time for the transfer destination to answer the call.
$room_name  : mixed
Generated from protobuf field <code>string room_name = 2;</code>
$transfer_to  : mixed
Generated from protobuf field <code>string transfer_to = 3;</code>
$headers  : mixed
Add the following headers to the REFER SIP request.

Methods

__construct()  : mixed
Constructor.
clearRingingTimeout()  : mixed
getHeaders()  : MapField
Add the following headers to the REFER SIP request.
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 1;</code>
getPlayDialtone()  : bool
Optionally play dialtone to the SIP participant as an audible indicator of being transferred
getRingingTimeout()  : Duration|null
Max time for the transfer destination to answer the call.
getRoomName()  : string
Generated from protobuf field <code>string room_name = 2;</code>
getTransferTo()  : string
Generated from protobuf field <code>string transfer_to = 3;</code>
hasRingingTimeout()  : mixed
setHeaders()  : $this
Add the following headers to the REFER SIP request.
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 1;</code>
setPlayDialtone()  : $this
Optionally play dialtone to the SIP participant as an audible indicator of being transferred
setRingingTimeout()  : $this
Max time for the transfer destination to answer the call.
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 2;</code>
setTransferTo()  : $this
Generated from protobuf field <code>string transfer_to = 3;</code>

Properties

$participant_identity

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

protected mixed $participant_identity = ''

$play_dialtone

Optionally play dialtone to the SIP participant as an audible indicator of being transferred

protected mixed $play_dialtone = false

Generated from protobuf field bool play_dialtone = 4;

$ringing_timeout

Max time for the transfer destination to answer the call.

protected mixed $ringing_timeout = null

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 6;

$headers

Add the following headers to the REFER SIP request.

private mixed $headers

Generated from protobuf field map<string, string> headers = 5 [(.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 $participant_identity
@type string $room_name
@type string $transfer_to
@type bool $play_dialtone
      Optionally play dialtone to the SIP participant as an audible indicator of being transferred
@type array|\Google\Protobuf\Internal\MapField $headers
      Add the following headers to the REFER SIP request.
@type \Google\Protobuf\Duration $ringing_timeout
      Max time for the transfer destination to answer the call.

}

getHeaders()

Add the following headers to the REFER SIP request.

public getHeaders() : MapField

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

Return values
MapField

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getPlayDialtone()

Optionally play dialtone to the SIP participant as an audible indicator of being transferred

public getPlayDialtone() : bool

Generated from protobuf field bool play_dialtone = 4;

Return values
bool

getRingingTimeout()

Max time for the transfer destination to answer the call.

public getRingingTimeout() : Duration|null

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 6;

Return values
Duration|null

getRoomName()

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

public getRoomName() : string
Return values
string

getTransferTo()

Generated from protobuf field <code>string transfer_to = 3;</code>

public getTransferTo() : string
Return values
string

setHeaders()

Add the following headers to the REFER SIP request.

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

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

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

setParticipantIdentity()

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

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

setPlayDialtone()

Optionally play dialtone to the SIP participant as an audible indicator of being transferred

public setPlayDialtone(bool $var) : $this

Generated from protobuf field bool play_dialtone = 4;

Parameters
$var : bool
Return values
$this

setRingingTimeout()

Max time for the transfer destination to answer the call.

public setRingingTimeout(Duration $var) : $this

Generated from protobuf field .google.protobuf.Duration ringing_timeout = 6;

Parameters
$var : Duration
Return values
$this

setRoomName()

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

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

setTransferTo()

Generated from protobuf field <code>string transfer_to = 3;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results