File: meet_v2.conferenceRecords.participants.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (185 lines) | stat: -rw-r--r-- 8,728 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="meet_v2.html">Google Meet API</a> . <a href="meet_v2.conferenceRecords.html">conferenceRecords</a> . <a href="meet_v2.conferenceRecords.participants.html">participants</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="meet_v2.conferenceRecords.participants.participantSessions.html">participantSessions()</a></code>
</p>
<p class="firstline">Returns the participantSessions Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a participant by participant ID.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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'`.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a participant by participant ID.

Args:
  name: string, Required. Resource name of the participant. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # User who attended or is attending a conference.
  &quot;anonymousUser&quot;: { # User who joins anonymously (meaning not signed into a Google Account). # Anonymous user.
    &quot;displayName&quot;: &quot;A String&quot;, # Output only. User provided name when they join a conference anonymously.
  },
  &quot;earliestStartTime&quot;: &quot;A String&quot;, # Output only. Time when the participant first joined the meeting.
  &quot;latestEndTime&quot;: &quot;A String&quot;, # Output only. Time when the participant left the meeting for the last time. This can be null if it&#x27;s an active meeting.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the participant. Format: `conferenceRecords/{conference_record}/participants/{participant}`
  &quot;phoneUser&quot;: { # User dialing in from a phone where the user&#x27;s identity is unknown because they haven&#x27;t signed in with a Google Account. # User calling from their phone.
    &quot;displayName&quot;: &quot;A String&quot;, # Output only. Partially redacted user&#x27;s phone number when calling.
  },
  &quot;signedinUser&quot;: { # A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices. # Signed-in user.
    &quot;displayName&quot;: &quot;A String&quot;, # Output only. For a personal device, it&#x27;s the user&#x27;s first name and last name. For a robot account, it&#x27;s the administrator-specified device name. For example, &quot;Altostrat Room&quot;.
    &quot;user&quot;: &quot;A String&quot;, # Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: `users/{user}`
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>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 `&#x27;participants/*, next_page_token&#x27;`.

Args:
  parent: string, Required. Format: `conferenceRecords/{conference_record}` (required)
  filter: string, Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). 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: integer, 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: string, Page token returned from previous List Call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response of ListParticipants method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to be circulated back for further List call if current List doesn&#x27;t include all the participants. Unset if all participants are returned.
  &quot;participants&quot;: [ # List of participants in one page.
    { # User who attended or is attending a conference.
      &quot;anonymousUser&quot;: { # User who joins anonymously (meaning not signed into a Google Account). # Anonymous user.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. User provided name when they join a conference anonymously.
      },
      &quot;earliestStartTime&quot;: &quot;A String&quot;, # Output only. Time when the participant first joined the meeting.
      &quot;latestEndTime&quot;: &quot;A String&quot;, # Output only. Time when the participant left the meeting for the last time. This can be null if it&#x27;s an active meeting.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the participant. Format: `conferenceRecords/{conference_record}/participants/{participant}`
      &quot;phoneUser&quot;: { # User dialing in from a phone where the user&#x27;s identity is unknown because they haven&#x27;t signed in with a Google Account. # User calling from their phone.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. Partially redacted user&#x27;s phone number when calling.
      },
      &quot;signedinUser&quot;: { # A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices. # Signed-in user.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. For a personal device, it&#x27;s the user&#x27;s first name and last name. For a robot account, it&#x27;s the administrator-specified device name. For example, &quot;Altostrat Room&quot;.
        &quot;user&quot;: &quot;A String&quot;, # Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: `users/{user}`
      },
    },
  ],
  &quot;totalSize&quot;: 42, # Total, exact number of `participants`. By default, this field isn&#x27;t included in the response. Set the field mask in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters) to receive this field in the response.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>