Google Apps Meet V2 Client - Class ListParticipantsRequest (0.5.1)

Reference documentation and code samples for the Google Apps Meet V2 Client class ListParticipantsRequest.

Request to fetch list of participants per conference.

Generated from protobuf message google.apps.meet.v2.ListParticipantsRequest

Namespace

Google \ Apps \ Meet \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Format: conferenceRecords/{conference_record}
↳ page_size int

Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.
↳ page_token string

Page token returned from previous List Call.
↳ filter string

Optional. User specified filtering condition in EBNF format. The following are the filterable fields: * * earliest_start_time * * latest_end_time For example, latest_end_time IS NULL returns active participants in the conference.

getParent

Required. Format: conferenceRecords/{conference_record}

Returns
Type Description
string

setParent

Required. Format: conferenceRecords/{conference_record}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum number of participants to return. The service might return fewer than this value.

If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.

Returns
Type Description
int

setPageSize

Maximum number of participants to return. The service might return fewer than this value.

If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Page token returned from previous List Call.

Returns
Type Description
string

setPageToken

Page token returned from previous List Call.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. User specified filtering condition in EBNF format.

The following are the filterable fields:

  • earliest_start_time
  • latest_end_time For example, latest_end_time IS NULL returns active participants in the conference.
Returns
Type Description
string

setFilter

Optional. User specified filtering condition in EBNF format.

The following are the filterable fields:

  • earliest_start_time
  • latest_end_time For example, latest_end_time IS NULL returns active participants in the conference.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Format: conferenceRecords/{conference_record} Please see ConferenceRecordsServiceClient::conferenceRecordName() for help formatting this field.
Returns
Type Description
ListParticipantsRequest