Documentation

PromoteAgentResponse extends Message
in package

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

Table of Contents

Properties

$agent_id  : mixed
Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>
$dst_deployment  : mixed
Generated from protobuf field <code>string dst_deployment = 5;</code>
$message  : mixed
Generated from protobuf field <code>string message = 2;</code>
$src_deployment  : mixed
Generated from protobuf field <code>string src_deployment = 4;</code>
$success  : mixed
Generated from protobuf field <code>bool success = 1;</code>
$version_tag  : mixed
Generated from protobuf field <code>string version_tag = 6;</code>

Methods

__construct()  : mixed
Constructor.
getAgentId()  : string
Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>
getDstDeployment()  : string
Generated from protobuf field <code>string dst_deployment = 5;</code>
getMessage()  : string
Generated from protobuf field <code>string message = 2;</code>
getSrcDeployment()  : string
Generated from protobuf field <code>string src_deployment = 4;</code>
getSuccess()  : bool
Generated from protobuf field <code>bool success = 1;</code>
getVersionTag()  : string
Generated from protobuf field <code>string version_tag = 6;</code>
setAgentId()  : $this
Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>
setDstDeployment()  : $this
Generated from protobuf field <code>string dst_deployment = 5;</code>
setMessage()  : $this
Generated from protobuf field <code>string message = 2;</code>
setSrcDeployment()  : $this
Generated from protobuf field <code>string src_deployment = 4;</code>
setSuccess()  : $this
Generated from protobuf field <code>bool success = 1;</code>
setVersionTag()  : $this
Generated from protobuf field <code>string version_tag = 6;</code>

Properties

$agent_id

Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>

protected mixed $agent_id = ''

$dst_deployment

Generated from protobuf field <code>string dst_deployment = 5;</code>

protected mixed $dst_deployment = ''

$message

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

protected mixed $message = ''

$src_deployment

Generated from protobuf field <code>string src_deployment = 4;</code>

protected mixed $src_deployment = ''

$success

Generated from protobuf field <code>bool success = 1;</code>

protected mixed $success = false

$version_tag

Generated from protobuf field <code>string version_tag = 6;</code>

protected mixed $version_tag = ''

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 bool $success
@type string $message
@type string $agent_id
@type string $src_deployment
@type string $dst_deployment
@type string $version_tag

}

getAgentId()

Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>

public getAgentId() : string
Return values
string

getDstDeployment()

Generated from protobuf field <code>string dst_deployment = 5;</code>

public getDstDeployment() : string
Return values
string

getMessage()

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

public getMessage() : string
Return values
string

getSrcDeployment()

Generated from protobuf field <code>string src_deployment = 4;</code>

public getSrcDeployment() : string
Return values
string

getSuccess()

Generated from protobuf field <code>bool success = 1;</code>

public getSuccess() : bool
Return values
bool

getVersionTag()

Generated from protobuf field <code>string version_tag = 6;</code>

public getVersionTag() : string
Return values
string

setAgentId()

Generated from protobuf field <code>string agent_id = 3 [(.logger.name) = "agentID"];</code>

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

setDstDeployment()

Generated from protobuf field <code>string dst_deployment = 5;</code>

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

setMessage()

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

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

setSrcDeployment()

Generated from protobuf field <code>string src_deployment = 4;</code>

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

setSuccess()

Generated from protobuf field <code>bool success = 1;</code>

public setSuccess(bool $var) : $this
Parameters
$var : bool
Return values
$this

setVersionTag()

Generated from protobuf field <code>string version_tag = 6;</code>

public setVersionTag(string $var) : $this
Parameters
$var : string
Return values
$this
On this page

Search results