Documentation

SessionDataHeader extends Message
in package

Generated from protobuf message <code>plugnmeet.SessionDataHeader</code>

Table of Contents

Properties

$data_type  : mixed
Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>
$key  : mixed
request: unset => all, set => one; response: always set
$last  : mixed
response only: true on the final streamed entry

Methods

__construct()  : mixed
Constructor.
clearKey()  : mixed
getDataType()  : int
Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>
getKey()  : string
request: unset => all, set => one; response: always set
getLast()  : bool
response only: true on the final streamed entry
hasKey()  : mixed
setDataType()  : $this
Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>
setKey()  : $this
request: unset => all, set => one; response: always set
setLast()  : $this
response only: true on the final streamed entry

Properties

$data_type

Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>

protected mixed $data_type = 0

$key

request: unset => all, set => one; response: always set

protected mixed $key = null

Generated from protobuf field optional string key = 2;

$last

response only: true on the final streamed entry

protected mixed $last = false

Generated from protobuf field bool last = 3;

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 int $data_type
@type string $key
      request: unset => all, set => one; response: always set
@type bool $last
      response only: true on the final streamed entry

}

getDataType()

Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>

public getDataType() : int
Return values
int

one of the values in SessionDataType

getKey()

request: unset => all, set => one; response: always set

public getKey() : string

Generated from protobuf field optional string key = 2;

Return values
string

getLast()

response only: true on the final streamed entry

public getLast() : bool

Generated from protobuf field bool last = 3;

Return values
bool

setDataType()

Generated from protobuf field <code>.plugnmeet.SessionDataType data_type = 1;</code>

public setDataType(int $var) : $this
Parameters
$var : int

one of the values in SessionDataType

Return values
$this

setKey()

request: unset => all, set => one; response: always set

public setKey(string $var) : $this

Generated from protobuf field optional string key = 2;

Parameters
$var : string
Return values
$this

setLast()

response only: true on the final streamed entry

public setLast(bool $var) : $this

Generated from protobuf field bool last = 3;

Parameters
$var : bool
Return values
$this
On this page

Search results