Documentation

AvailabilityResponse extends Message
in package

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

Table of Contents

Properties

$available  : mixed
Generated from protobuf field <code>bool available = 2;</code>
$job_id  : mixed
Generated from protobuf field <code>string job_id = 1;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 5;</code>
$participant_metadata  : mixed
Generated from protobuf field <code>string participant_metadata = 6;</code>
$participant_name  : mixed
Generated from protobuf field <code>string participant_name = 4;</code>
$supports_resume  : mixed
Generated from protobuf field <code>bool supports_resume = 3;</code>
$terminate  : mixed
Generated from protobuf field <code>bool terminate = 8;</code>
$participant_attributes  : mixed
NEXT_ID: 9

Methods

__construct()  : mixed
Constructor.
getAvailable()  : bool
Generated from protobuf field <code>bool available = 2;</code>
getJobId()  : string
Generated from protobuf field <code>string job_id = 1;</code>
getParticipantAttributes()  : MapField
NEXT_ID: 9
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 5;</code>
getParticipantMetadata()  : string
Generated from protobuf field <code>string participant_metadata = 6;</code>
getParticipantName()  : string
Generated from protobuf field <code>string participant_name = 4;</code>
getSupportsResume()  : bool
Generated from protobuf field <code>bool supports_resume = 3;</code>
getTerminate()  : bool
Generated from protobuf field <code>bool terminate = 8;</code>
setAvailable()  : $this
Generated from protobuf field <code>bool available = 2;</code>
setJobId()  : $this
Generated from protobuf field <code>string job_id = 1;</code>
setParticipantAttributes()  : $this
NEXT_ID: 9
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 5;</code>
setParticipantMetadata()  : $this
Generated from protobuf field <code>string participant_metadata = 6;</code>
setParticipantName()  : $this
Generated from protobuf field <code>string participant_name = 4;</code>
setSupportsResume()  : $this
Generated from protobuf field <code>bool supports_resume = 3;</code>
setTerminate()  : $this
Generated from protobuf field <code>bool terminate = 8;</code>

Properties

$available

Generated from protobuf field <code>bool available = 2;</code>

protected mixed $available = false

$job_id

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

protected mixed $job_id = ''

$participant_identity

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

protected mixed $participant_identity = ''

$participant_metadata

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

protected mixed $participant_metadata = ''

$participant_name

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

protected mixed $participant_name = ''

$supports_resume

Generated from protobuf field <code>bool supports_resume = 3;</code>

protected mixed $supports_resume = false

$terminate

Generated from protobuf field <code>bool terminate = 8;</code>

protected mixed $terminate = false

$participant_attributes

NEXT_ID: 9

private mixed $participant_attributes

Generated from protobuf field map<string, string> participant_attributes = 7;

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 $job_id
@type bool $available
@type bool $supports_resume
@type bool $terminate
@type string $participant_name
@type string $participant_identity
@type string $participant_metadata
@type array|\Google\Protobuf\Internal\MapField $participant_attributes
      NEXT_ID: 9

}

getAvailable()

Generated from protobuf field <code>bool available = 2;</code>

public getAvailable() : bool
Return values
bool

getJobId()

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

public getJobId() : string
Return values
string

getParticipantAttributes()

NEXT_ID: 9

public getParticipantAttributes() : MapField

Generated from protobuf field map<string, string> participant_attributes = 7;

Return values
MapField

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getParticipantMetadata()

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

public getParticipantMetadata() : string
Return values
string

getParticipantName()

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

public getParticipantName() : string
Return values
string

getSupportsResume()

Generated from protobuf field <code>bool supports_resume = 3;</code>

public getSupportsResume() : bool
Return values
bool

getTerminate()

Generated from protobuf field <code>bool terminate = 8;</code>

public getTerminate() : bool
Return values
bool

setAvailable()

Generated from protobuf field <code>bool available = 2;</code>

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

setJobId()

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

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

setParticipantAttributes()

NEXT_ID: 9

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

Generated from protobuf field map<string, string> participant_attributes = 7;

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

setParticipantIdentity()

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

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

setParticipantMetadata()

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

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

setParticipantName()

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

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

setSupportsResume()

Generated from protobuf field <code>bool supports_resume = 3;</code>

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

setTerminate()

Generated from protobuf field <code>bool terminate = 8;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results