AgentDispatch
extends Message
in package
Generated from protobuf message <code>livekit.AgentDispatch</code>
Table of Contents
Properties
- $agent_name : mixed
- Generated from protobuf field <code>string agent_name = 2;</code>
- $deployment : mixed
- Generated from protobuf field <code>string deployment = 7;</code>
- $id : mixed
- Generated from protobuf field <code>string id = 1;</code>
- $metadata : mixed
- Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
- $restart_policy : mixed
- cloud only
- $room : mixed
- Generated from protobuf field <code>string room = 3;</code>
- $state : mixed
- Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
Methods
- __construct() : mixed
- Constructor.
- clearState() : mixed
- getAgentName() : string
- Generated from protobuf field <code>string agent_name = 2;</code>
- getDeployment() : string
- Generated from protobuf field <code>string deployment = 7;</code>
- getId() : string
- Generated from protobuf field <code>string id = 1;</code>
- getMetadata() : string
- Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
- getRestartPolicy() : int
- cloud only
- getRoom() : string
- Generated from protobuf field <code>string room = 3;</code>
- getState() : AgentDispatchState|null
- Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
- hasState() : mixed
- setAgentName() : $this
- Generated from protobuf field <code>string agent_name = 2;</code>
- setDeployment() : $this
- Generated from protobuf field <code>string deployment = 7;</code>
- setId() : $this
- Generated from protobuf field <code>string id = 1;</code>
- setMetadata() : $this
- Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
- setRestartPolicy() : $this
- cloud only
- setRoom() : $this
- Generated from protobuf field <code>string room = 3;</code>
- setState() : $this
- Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
Properties
$agent_name
Generated from protobuf field <code>string agent_name = 2;</code>
protected
mixed
$agent_name
= ''
$deployment
Generated from protobuf field <code>string deployment = 7;</code>
protected
mixed
$deployment
= ''
$id
Generated from protobuf field <code>string id = 1;</code>
protected
mixed
$id
= ''
$metadata
Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
protected
mixed
$metadata
= ''
$restart_policy
cloud only
protected
mixed
$restart_policy
= 0
Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 6;
$room
Generated from protobuf field <code>string room = 3;</code>
protected
mixed
$room
= ''
$state
Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
protected
mixed
$state
= null
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 $id @type string $agent_name @type string $room @type string $metadata @type \Livekit\AgentDispatchState $state @type int $restart_policy cloud only @type string $deployment}
clearState()
public
clearState() : mixed
getAgentName()
Generated from protobuf field <code>string agent_name = 2;</code>
public
getAgentName() : string
Return values
stringgetDeployment()
Generated from protobuf field <code>string deployment = 7;</code>
public
getDeployment() : string
Return values
stringgetId()
Generated from protobuf field <code>string id = 1;</code>
public
getId() : string
Return values
stringgetMetadata()
Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
public
getMetadata() : string
Return values
stringgetRestartPolicy()
cloud only
public
getRestartPolicy() : int
Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 6;
Return values
intgetRoom()
Generated from protobuf field <code>string room = 3;</code>
public
getRoom() : string
Return values
stringgetState()
Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
public
getState() : AgentDispatchState|null
Return values
AgentDispatchState|nullhasState()
public
hasState() : mixed
setAgentName()
Generated from protobuf field <code>string agent_name = 2;</code>
public
setAgentName(string $var) : $this
Parameters
- $var : string
Return values
$thissetDeployment()
Generated from protobuf field <code>string deployment = 7;</code>
public
setDeployment(string $var) : $this
Parameters
- $var : string
Return values
$thissetId()
Generated from protobuf field <code>string id = 1;</code>
public
setId(string $var) : $this
Parameters
- $var : string
Return values
$thissetMetadata()
Generated from protobuf field <code>string metadata = 4 [(.logger.redact) = true];</code>
public
setMetadata(string $var) : $this
Parameters
- $var : string
Return values
$thissetRestartPolicy()
cloud only
public
setRestartPolicy(int $var) : $this
Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 6;
Parameters
- $var : int
Return values
$thissetRoom()
Generated from protobuf field <code>string room = 3;</code>
public
setRoom(string $var) : $this
Parameters
- $var : string
Return values
$thissetState()
Generated from protobuf field <code>.livekit.AgentDispatchState state = 5;</code>
public
setState(AgentDispatchState $var) : $this
Parameters
- $var : AgentDispatchState