1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\Meet\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Meet\ListParticipantsResponse;
|
---|
21 | use Google\Service\Meet\Participant;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "participants" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $meetService = new Google\Service\Meet(...);
|
---|
28 | * $participants = $meetService->conferenceRecords_participants;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class ConferenceRecordsParticipants extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Gets a participant by participant ID. (participants.get)
|
---|
35 | *
|
---|
36 | * @param string $name Required. Resource name of the participant.
|
---|
37 | * @param array $optParams Optional parameters.
|
---|
38 | * @return Participant
|
---|
39 | * @throws \Google\Service\Exception
|
---|
40 | */
|
---|
41 | public function get($name, $optParams = [])
|
---|
42 | {
|
---|
43 | $params = ['name' => $name];
|
---|
44 | $params = array_merge($params, $optParams);
|
---|
45 | return $this->call('get', [$params], Participant::class);
|
---|
46 | }
|
---|
47 | /**
|
---|
48 | * Lists the participants in a conference record. By default, ordered by join
|
---|
49 | * time and in descending order. This API supports `fields` as standard
|
---|
50 | * parameters like every other API. However, when the `fields` request parameter
|
---|
51 | * is omitted, this API defaults to `'participants, next_page_token'`.
|
---|
52 | * (participants.listConferenceRecordsParticipants)
|
---|
53 | *
|
---|
54 | * @param string $parent Required. Format:
|
---|
55 | * `conferenceRecords/{conference_record}`
|
---|
56 | * @param array $optParams Optional parameters.
|
---|
57 | *
|
---|
58 | * @opt_param string filter Optional. User specified filtering condition in
|
---|
59 | * [EBNF
|
---|
60 | * format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The
|
---|
61 | * following are the filterable fields: * `earliest_start_time` *
|
---|
62 | * `latest_end_time` For example, `latest_end_time IS NULL` returns active
|
---|
63 | * participants in the conference.
|
---|
64 | * @opt_param int pageSize Maximum number of participants to return. The service
|
---|
65 | * might return fewer than this value. If unspecified, at most 100 participants
|
---|
66 | * are returned. The maximum value is 250; values above 250 are coerced to 250.
|
---|
67 | * Maximum might change in the future.
|
---|
68 | * @opt_param string pageToken Page token returned from previous List Call.
|
---|
69 | * @return ListParticipantsResponse
|
---|
70 | * @throws \Google\Service\Exception
|
---|
71 | */
|
---|
72 | public function listConferenceRecordsParticipants($parent, $optParams = [])
|
---|
73 | {
|
---|
74 | $params = ['parent' => $parent];
|
---|
75 | $params = array_merge($params, $optParams);
|
---|
76 | return $this->call('list', [$params], ListParticipantsResponse::class);
|
---|
77 | }
|
---|
78 | }
|
---|
79 |
|
---|
80 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
81 | class_alias(ConferenceRecordsParticipants::class, 'Google_Service_Meet_Resource_ConferenceRecordsParticipants');
|
---|