Documentation

CreateBreakoutRoomsReq extends Message
in package

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

Table of Contents

Properties

$allow_return_to_main_room  : mixed
Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>
$allow_self_select  : mixed
Generated from protobuf field <code>bool allow_self_select = 11;</code>
$duration  : mixed
Generated from protobuf field <code>uint64 duration = 3;</code>
$poll_share  : mixed
Generated from protobuf field <code>optional .plugnmeet.PollShare poll_share = 7;</code>
$requested_user_id  : mixed
Generated from protobuf field <code>string requested_user_id = 2;</code>
$room_id  : mixed
Generated from protobuf field <code>string room_id = 1;</code>
$share_notepad  : mixed
Generated from protobuf field <code>bool share_notepad = 8;</code>
$welcome_msg  : mixed
Generated from protobuf field <code>optional string welcome_msg = 4;</code>
$whiteboard_share  : mixed
Generated from protobuf field <code>optional .plugnmeet.WhiteboardShare whiteboard_share = 6;</code>
$rooms  : mixed
Generated from protobuf field <code>repeated .plugnmeet.BreakoutRoom rooms = 5;</code>

Methods

__construct()  : mixed
Constructor.
clearPollShare()  : mixed
clearWelcomeMsg()  : mixed
clearWhiteboardShare()  : mixed
getAllowReturnToMainRoom()  : bool
Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>
getAllowSelfSelect()  : bool
Generated from protobuf field <code>bool allow_self_select = 11;</code>
getDuration()  : int|string
Generated from protobuf field <code>uint64 duration = 3;</code>
getPollShare()  : PollShare|null
Generated from protobuf field <code>optional .plugnmeet.PollShare poll_share = 7;</code>
getRequestedUserId()  : string
Generated from protobuf field <code>string requested_user_id = 2;</code>
getRoomId()  : string
Generated from protobuf field <code>string room_id = 1;</code>
getRooms()  : RepeatedField<string|int, BreakoutRoom>
Generated from protobuf field <code>repeated .plugnmeet.BreakoutRoom rooms = 5;</code>
getShareNotepad()  : bool
Generated from protobuf field <code>bool share_notepad = 8;</code>
getWelcomeMsg()  : string
Generated from protobuf field <code>optional string welcome_msg = 4;</code>
getWhiteboardShare()  : WhiteboardShare|null
Generated from protobuf field <code>optional .plugnmeet.WhiteboardShare whiteboard_share = 6;</code>
hasPollShare()  : mixed
hasWelcomeMsg()  : mixed
hasWhiteboardShare()  : mixed
setAllowReturnToMainRoom()  : $this
Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>
setAllowSelfSelect()  : $this
Generated from protobuf field <code>bool allow_self_select = 11;</code>
setDuration()  : $this
Generated from protobuf field <code>uint64 duration = 3;</code>
setPollShare()  : $this
Generated from protobuf field <code>optional .plugnmeet.PollShare poll_share = 7;</code>
setRequestedUserId()  : $this
Generated from protobuf field <code>string requested_user_id = 2;</code>
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 1;</code>
setRooms()  : $this
Generated from protobuf field <code>repeated .plugnmeet.BreakoutRoom rooms = 5;</code>
setShareNotepad()  : $this
Generated from protobuf field <code>bool share_notepad = 8;</code>
setWelcomeMsg()  : $this
Generated from protobuf field <code>optional string welcome_msg = 4;</code>
setWhiteboardShare()  : $this
Generated from protobuf field <code>optional .plugnmeet.WhiteboardShare whiteboard_share = 6;</code>

Properties

$allow_return_to_main_room

Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>

protected mixed $allow_return_to_main_room = false

$allow_self_select

Generated from protobuf field <code>bool allow_self_select = 11;</code>

protected mixed $allow_self_select = false

$duration

Generated from protobuf field <code>uint64 duration = 3;</code>

protected mixed $duration = 0

$poll_share

Generated from protobuf field <code>optional .plugnmeet.PollShare poll_share = 7;</code>

protected mixed $poll_share = null

$requested_user_id

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

protected mixed $requested_user_id = ''

$room_id

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

protected mixed $room_id = ''

$share_notepad

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

protected mixed $share_notepad = false

$welcome_msg

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

protected mixed $welcome_msg = null

$whiteboard_share

Generated from protobuf field <code>optional .plugnmeet.WhiteboardShare whiteboard_share = 6;</code>

protected mixed $whiteboard_share = null

$rooms

Generated from protobuf field <code>repeated .plugnmeet.BreakoutRoom rooms = 5;</code>

private mixed $rooms

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 $room_id
@type string $requested_user_id
@type int|string $duration
@type string $welcome_msg
@type \Mynaparrot\PlugnmeetProto\BreakoutRoom[] $rooms
@type \Mynaparrot\PlugnmeetProto\WhiteboardShare $whiteboard_share
@type \Mynaparrot\PlugnmeetProto\PollShare $poll_share
@type bool $share_notepad
@type bool $allow_return_to_main_room
@type bool $allow_self_select

}

getAllowReturnToMainRoom()

Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>

public getAllowReturnToMainRoom() : bool
Return values
bool

getAllowSelfSelect()

Generated from protobuf field <code>bool allow_self_select = 11;</code>

public getAllowSelfSelect() : bool
Return values
bool

getDuration()

Generated from protobuf field <code>uint64 duration = 3;</code>

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

getRequestedUserId()

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

public getRequestedUserId() : string
Return values
string

getRoomId()

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

public getRoomId() : string
Return values
string

getShareNotepad()

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

public getShareNotepad() : bool
Return values
bool

getWelcomeMsg()

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

public getWelcomeMsg() : string
Return values
string

setAllowReturnToMainRoom()

Generated from protobuf field <code>bool allow_return_to_main_room = 9;</code>

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

setAllowSelfSelect()

Generated from protobuf field <code>bool allow_self_select = 11;</code>

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

setDuration()

Generated from protobuf field <code>uint64 duration = 3;</code>

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

setPollShare()

Generated from protobuf field <code>optional .plugnmeet.PollShare poll_share = 7;</code>

public setPollShare(PollShare $var) : $this
Parameters
$var : PollShare
Return values
$this

setRequestedUserId()

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

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

setRoomId()

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

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

setRooms()

Generated from protobuf field <code>repeated .plugnmeet.BreakoutRoom rooms = 5;</code>

public setRooms(array<string|int, BreakoutRoom> $var) : $this
Parameters
$var : array<string|int, BreakoutRoom>
Return values
$this

setShareNotepad()

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

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

setWelcomeMsg()

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

public setWelcomeMsg(string $var) : $this
Parameters
$var : string
Return values
$this
On this page

Search results