list method
Lists the participants in a conference record.
By default, ordered by join time and in descending order. This API
supports fields
as standard parameters like every other API. However,
when the fields
request parameter is omitted, this API defaults to
'participants / * , next_page_token'
.
Request parameters:
parent
- Required. Format: conferenceRecords/{conference_record}
Value must have pattern ^conferenceRecords/\[^/\]+$
.
filter
- 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.
pageSize
- 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.
pageToken
- Page token returned from previous List Call.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListParticipantsResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<ListParticipantsResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/participants';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListParticipantsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}