Documentation

ListIngressRequest extends Message
in package

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

Table of Contents

Properties

$ingress_id  : mixed
(optional, filter by ingress ID)
$page_token  : mixed
Generated from protobuf field <code>.livekit.TokenPagination page_token = 3;</code>
$room_name  : mixed
when blank, lists all ingress endpoints

Methods

__construct()  : mixed
Constructor.
clearPageToken()  : mixed
getIngressId()  : string
(optional, filter by ingress ID)
getPageToken()  : TokenPagination|null
Generated from protobuf field <code>.livekit.TokenPagination page_token = 3;</code>
getRoomName()  : string
when blank, lists all ingress endpoints
hasPageToken()  : mixed
setIngressId()  : $this
(optional, filter by ingress ID)
setPageToken()  : $this
Generated from protobuf field <code>.livekit.TokenPagination page_token = 3;</code>
setRoomName()  : $this
when blank, lists all ingress endpoints

Properties

$ingress_id

(optional, filter by ingress ID)

protected mixed $ingress_id = ''

Generated from protobuf field string ingress_id = 2;

$page_token

Generated from protobuf field <code>.livekit.TokenPagination page_token = 3;</code>

protected mixed $page_token = null

$room_name

when blank, lists all ingress endpoints

protected mixed $room_name = ''

Generated from protobuf field string room_name = 1;

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 \Livekit\TokenPagination $page_token
@type string $room_name
      when blank, lists all ingress endpoints
@type string $ingress_id
      (optional, filter by ingress ID)

}

getIngressId()

(optional, filter by ingress ID)

public getIngressId() : string

Generated from protobuf field string ingress_id = 2;

Return values
string

getRoomName()

when blank, lists all ingress endpoints

public getRoomName() : string

Generated from protobuf field string room_name = 1;

Return values
string

setIngressId()

(optional, filter by ingress ID)

public setIngressId(string $var) : $this

Generated from protobuf field string ingress_id = 2;

Parameters
$var : string
Return values
$this

setRoomName()

when blank, lists all ingress endpoints

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 1;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results