Documentation

WebhookInfo extends Message
in package

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

Table of Contents

Properties

$created_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>
$egress_id  : mixed
Generated from protobuf field <code>string egress_id = 9;</code>
$event  : mixed
Generated from protobuf field <code>string event = 2;</code>
$event_id  : mixed
Generated from protobuf field <code>string event_id = 1;</code>
$ingress_id  : mixed
Generated from protobuf field <code>string ingress_id = 10;</code>
$is_dropped  : mixed
Generated from protobuf field <code>bool is_dropped = 18;</code>
$num_dropped  : mixed
Generated from protobuf field <code>int32 num_dropped = 17;</code>
$participant_id  : mixed
Generated from protobuf field <code>string participant_id = 7;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 6;</code>
$project_id  : mixed
Generated from protobuf field <code>string project_id = 3;</code>
$queue_duration_ns  : mixed
Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>
$queued_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>
$room_id  : mixed
Generated from protobuf field <code>string room_id = 5;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 4;</code>
$send_duration_ns  : mixed
Generated from protobuf field <code>int64 send_duration_ns = 15;</code>
$send_error  : mixed
Generated from protobuf field <code>string send_error = 22;</code>
$sent_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>
$service_error  : mixed
Generated from protobuf field <code>string service_error = 21;</code>
$service_error_code  : mixed
Generated from protobuf field <code>int32 service_error_code = 20;</code>
$service_status  : mixed
Generated from protobuf field <code>string service_status = 19;</code>
$track_id  : mixed
Generated from protobuf field <code>string track_id = 8;</code>
$url  : mixed
Generated from protobuf field <code>string url = 16;</code>

Methods

__construct()  : mixed
Constructor.
clearCreatedAt()  : mixed
clearQueuedAt()  : mixed
clearSentAt()  : mixed
getCreatedAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>
getEgressId()  : string
Generated from protobuf field <code>string egress_id = 9;</code>
getEvent()  : string
Generated from protobuf field <code>string event = 2;</code>
getEventId()  : string
Generated from protobuf field <code>string event_id = 1;</code>
getIngressId()  : string
Generated from protobuf field <code>string ingress_id = 10;</code>
getIsDropped()  : bool
Generated from protobuf field <code>bool is_dropped = 18;</code>
getNumDropped()  : int
Generated from protobuf field <code>int32 num_dropped = 17;</code>
getParticipantId()  : string
Generated from protobuf field <code>string participant_id = 7;</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 6;</code>
getProjectId()  : string
Generated from protobuf field <code>string project_id = 3;</code>
getQueuedAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>
getQueueDurationNs()  : int|string
Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>
getRoomId()  : string
Generated from protobuf field <code>string room_id = 5;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 4;</code>
getSendDurationNs()  : int|string
Generated from protobuf field <code>int64 send_duration_ns = 15;</code>
getSendError()  : string
Generated from protobuf field <code>string send_error = 22;</code>
getSentAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>
getServiceError()  : string
Generated from protobuf field <code>string service_error = 21;</code>
getServiceErrorCode()  : int
Generated from protobuf field <code>int32 service_error_code = 20;</code>
getServiceStatus()  : string
Generated from protobuf field <code>string service_status = 19;</code>
getTrackId()  : string
Generated from protobuf field <code>string track_id = 8;</code>
getUrl()  : string
Generated from protobuf field <code>string url = 16;</code>
hasCreatedAt()  : mixed
hasQueuedAt()  : mixed
hasSentAt()  : mixed
setCreatedAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>
setEgressId()  : $this
Generated from protobuf field <code>string egress_id = 9;</code>
setEvent()  : $this
Generated from protobuf field <code>string event = 2;</code>
setEventId()  : $this
Generated from protobuf field <code>string event_id = 1;</code>
setIngressId()  : $this
Generated from protobuf field <code>string ingress_id = 10;</code>
setIsDropped()  : $this
Generated from protobuf field <code>bool is_dropped = 18;</code>
setNumDropped()  : $this
Generated from protobuf field <code>int32 num_dropped = 17;</code>
setParticipantId()  : $this
Generated from protobuf field <code>string participant_id = 7;</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 6;</code>
setProjectId()  : $this
Generated from protobuf field <code>string project_id = 3;</code>
setQueuedAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>
setQueueDurationNs()  : $this
Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 5;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 4;</code>
setSendDurationNs()  : $this
Generated from protobuf field <code>int64 send_duration_ns = 15;</code>
setSendError()  : $this
Generated from protobuf field <code>string send_error = 22;</code>
setSentAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>
setServiceError()  : $this
Generated from protobuf field <code>string service_error = 21;</code>
setServiceErrorCode()  : $this
Generated from protobuf field <code>int32 service_error_code = 20;</code>
setServiceStatus()  : $this
Generated from protobuf field <code>string service_status = 19;</code>
setTrackId()  : $this
Generated from protobuf field <code>string track_id = 8;</code>
setUrl()  : $this
Generated from protobuf field <code>string url = 16;</code>

Properties

$created_at

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>

protected mixed $created_at = null

$egress_id

Generated from protobuf field <code>string egress_id = 9;</code>

protected mixed $egress_id = ''

$event

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

protected mixed $event = ''

$event_id

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

protected mixed $event_id = ''

$ingress_id

Generated from protobuf field <code>string ingress_id = 10;</code>

protected mixed $ingress_id = ''

$is_dropped

Generated from protobuf field <code>bool is_dropped = 18;</code>

protected mixed $is_dropped = false

$num_dropped

Generated from protobuf field <code>int32 num_dropped = 17;</code>

protected mixed $num_dropped = 0

$participant_id

Generated from protobuf field <code>string participant_id = 7;</code>

protected mixed $participant_id = ''

$participant_identity

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

protected mixed $participant_identity = ''

$project_id

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

protected mixed $project_id = ''

$queue_duration_ns

Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>

protected mixed $queue_duration_ns = 0

$queued_at

Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>

protected mixed $queued_at = null

$room_id

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

protected mixed $room_id = ''

$room_name

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

protected mixed $room_name = ''

$send_duration_ns

Generated from protobuf field <code>int64 send_duration_ns = 15;</code>

protected mixed $send_duration_ns = 0

$send_error

Generated from protobuf field <code>string send_error = 22;</code>

protected mixed $send_error = ''

$sent_at

Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>

protected mixed $sent_at = null

$service_error

Generated from protobuf field <code>string service_error = 21;</code>

protected mixed $service_error = ''

$service_error_code

Generated from protobuf field <code>int32 service_error_code = 20;</code>

protected mixed $service_error_code = 0

$service_status

Generated from protobuf field <code>string service_status = 19;</code>

protected mixed $service_status = ''

$track_id

Generated from protobuf field <code>string track_id = 8;</code>

protected mixed $track_id = ''

$url

Generated from protobuf field <code>string url = 16;</code>

protected mixed $url = ''

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 $event_id
@type string $event
@type string $project_id
@type string $room_name
@type string $room_id
@type string $participant_identity
@type string $participant_id
@type string $track_id
@type string $egress_id
@type string $ingress_id
@type \Google\Protobuf\Timestamp $created_at
@type \Google\Protobuf\Timestamp $queued_at
@type int|string $queue_duration_ns
@type \Google\Protobuf\Timestamp $sent_at
@type int|string $send_duration_ns
@type string $url
@type int $num_dropped
@type bool $is_dropped
@type string $service_status
@type int $service_error_code
@type string $service_error
@type string $send_error

}

getCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>

public getCreatedAt() : Timestamp|null
Return values
Timestamp|null

getEgressId()

Generated from protobuf field <code>string egress_id = 9;</code>

public getEgressId() : string
Return values
string

getEvent()

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

public getEvent() : string
Return values
string

getEventId()

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

public getEventId() : string
Return values
string

getIngressId()

Generated from protobuf field <code>string ingress_id = 10;</code>

public getIngressId() : string
Return values
string

getIsDropped()

Generated from protobuf field <code>bool is_dropped = 18;</code>

public getIsDropped() : bool
Return values
bool

getNumDropped()

Generated from protobuf field <code>int32 num_dropped = 17;</code>

public getNumDropped() : int
Return values
int

getParticipantId()

Generated from protobuf field <code>string participant_id = 7;</code>

public getParticipantId() : string
Return values
string

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getProjectId()

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

public getProjectId() : string
Return values
string

getQueuedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>

public getQueuedAt() : Timestamp|null
Return values
Timestamp|null

getQueueDurationNs()

Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>

public getQueueDurationNs() : int|string
Return values
int|string

getRoomId()

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

public getRoomId() : string
Return values
string

getRoomName()

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

public getRoomName() : string
Return values
string

getSendDurationNs()

Generated from protobuf field <code>int64 send_duration_ns = 15;</code>

public getSendDurationNs() : int|string
Return values
int|string

getSendError()

Generated from protobuf field <code>string send_error = 22;</code>

public getSendError() : string
Return values
string

getSentAt()

Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>

public getSentAt() : Timestamp|null
Return values
Timestamp|null

getServiceError()

Generated from protobuf field <code>string service_error = 21;</code>

public getServiceError() : string
Return values
string

getServiceErrorCode()

Generated from protobuf field <code>int32 service_error_code = 20;</code>

public getServiceErrorCode() : int
Return values
int

getServiceStatus()

Generated from protobuf field <code>string service_status = 19;</code>

public getServiceStatus() : string
Return values
string

getTrackId()

Generated from protobuf field <code>string track_id = 8;</code>

public getTrackId() : string
Return values
string

getUrl()

Generated from protobuf field <code>string url = 16;</code>

public getUrl() : string
Return values
string

setCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 11;</code>

public setCreatedAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setEgressId()

Generated from protobuf field <code>string egress_id = 9;</code>

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

setEvent()

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

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

setEventId()

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

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

setIngressId()

Generated from protobuf field <code>string ingress_id = 10;</code>

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

setIsDropped()

Generated from protobuf field <code>bool is_dropped = 18;</code>

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

setNumDropped()

Generated from protobuf field <code>int32 num_dropped = 17;</code>

public setNumDropped(int $var) : $this
Parameters
$var : int
Return values
$this

setParticipantId()

Generated from protobuf field <code>string participant_id = 7;</code>

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

setParticipantIdentity()

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

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

setProjectId()

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

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

setQueuedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp queued_at = 12;</code>

public setQueuedAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setQueueDurationNs()

Generated from protobuf field <code>int64 queue_duration_ns = 13;</code>

public setQueueDurationNs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setRoomId()

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

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

setRoomName()

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

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

setSendDurationNs()

Generated from protobuf field <code>int64 send_duration_ns = 15;</code>

public setSendDurationNs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setSendError()

Generated from protobuf field <code>string send_error = 22;</code>

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

setSentAt()

Generated from protobuf field <code>.google.protobuf.Timestamp sent_at = 14;</code>

public setSentAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setServiceError()

Generated from protobuf field <code>string service_error = 21;</code>

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

setServiceErrorCode()

Generated from protobuf field <code>int32 service_error_code = 20;</code>

public setServiceErrorCode(int $var) : $this
Parameters
$var : int
Return values
$this

setServiceStatus()

Generated from protobuf field <code>string service_status = 19;</code>

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

setTrackId()

Generated from protobuf field <code>string track_id = 8;</code>

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

setUrl()

Generated from protobuf field <code>string url = 16;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results