Debian Codegraph @

docs/dyn/firebaseappdistribution_v1.projects.groups.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="firebaseappdistribution_v1.html">Firebase App Distribution API</a> . <a href="firebaseappdistribution_v1.projects.html">projects</a> . <a href="firebaseappdistribution_v1.projects.groups.html">groups</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#batchJoin">batchJoin(group, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Batch adds members to a group. The testers will gain access to all releases that the groups have access to.</p>
80 <p class="toc_element">
81 <code><a href="#batchLeave">batchLeave(group, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Batch removed members from a group. The testers will lose access to all releases that the groups have access to.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#create">create(parent, body=None, groupId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Create a group.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
91 <p class="firstline">Delete a group.</p>
92 <p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94 <p class="firstline">Get a group.</p>
95 <p class="toc_element">
96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">List groups.</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Update a group.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="batchJoin">batchJoin(group, body=None, x__xgafv=None)</code>
107 <pre>Batch adds members to a group. The testers will gain access to all releases that the groups have access to.
108
109 Args:
110 group: string, Required. The name of the group resource to which testers are added. Format: `projects/{project_number}/groups/{group_alias}` (required)
111 body: object, The request body.
112 The object takes the form of:
113
114 { # The request message for `BatchJoinGroup`
115 &quot;createMissingTesters&quot;: True or False, # Indicates whether to create tester resources based on `emails` if they don&#x27;t exist yet.
116 &quot;emails&quot;: [ # Required. The emails of the testers to be added to the group. A maximum of 999 and a minimum of 1 tester can be created in a batch.
117 &quot;A String&quot;,
118 ],
119 }
120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126 Returns:
127 An object of the form:
128
129 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
130 }</pre>
131 </div>
132
133 <div class="method">
134 <code class="details" id="batchLeave">batchLeave(group, body=None, x__xgafv=None)</code>
135 <pre>Batch removed members from a group. The testers will lose access to all releases that the groups have access to.
136
137 Args:
138 group: string, Required. The name of the group resource from which testers are removed. Format: `projects/{project_number}/groups/{group_alias}` (required)
139 body: object, The request body.
140 The object takes the form of:
141
142 { # Request message for `BatchLeaveGroup`
143 &quot;emails&quot;: [ # Required. The email addresses of the testers to be removed from the group. A maximum of 999 and a minimum of 1 testers can be removed in a batch.
144 &quot;A String&quot;,
145 ],
146 }
147
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153 Returns:
154 An object of the form:
155
156 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
157 }</pre>
158 </div>
159
160 <div class="method">
161 <code class="details" id="close">close()</code>
162 <pre>Close httplib2 connections.</pre>
163 </div>
164
165 <div class="method">
166 <code class="details" id="create">create(parent, body=None, groupId=None, x__xgafv=None)</code>
167 <pre>Create a group.
168
169 Args:
170 parent: string, Required. The name of the project resource, which is the parent of the group resource. Format: `projects/{project_number}` (required)
171 body: object, The request body.
172 The object takes the form of:
173
174 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
175 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
176 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
177 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
178 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
179 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
180 }
181
182 groupId: string, Optional. The &quot;alias&quot; to use for the group, which will become the final component of the group&#x27;s resource name. This value must be unique per project. The field is named `groupId` to comply with AIP guidance for user-specified IDs. This value should be 4-63 characters, and valid characters are `/a-z-/`. If not set, it will be generated based on the display name.
183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188 Returns:
189 An object of the form:
190
191 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
192 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
193 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
194 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
195 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
196 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
197 }</pre>
198 </div>
199
200 <div class="method">
201 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
202 <pre>Delete a group.
203
204 Args:
205 name: string, Required. The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}` (required)
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211 Returns:
212 An object of the form:
213
214 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
215 }</pre>
216 </div>
217
218 <div class="method">
219 <code class="details" id="get">get(name, x__xgafv=None)</code>
220 <pre>Get a group.
221
222 Args:
223 name: string, Required. The name of the group resource to retrieve. Format: `projects/{project_number}/groups/{group_alias}` (required)
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229 Returns:
230 An object of the form:
231
232 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
233 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
234 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
235 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
236 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
237 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
238 }</pre>
239 </div>
240
241 <div class="method">
242 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
243 <pre>List groups.
244
245 Args:
246 parent: string, Required. The name of the project resource, which is the parent of the group resources. Format: `projects/{project_number}` (required)
247 pageSize: integer, Optional. The maximum number of groups to return. The service may return fewer than this value. The valid range is [1-1000]; If unspecified (0), at most 25 groups are returned. Values above 1000 are coerced to 1000.
248 pageToken: string, Optional. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token.
249 x__xgafv: string, V1 error format.
250 Allowed values
251 1 - v1 error format
252 2 - v2 error format
253
254 Returns:
255 An object of the form:
256
257 { # The response message for `ListGroups`.
258 &quot;groups&quot;: [ # The groups listed.
259 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
260 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
261 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
262 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
263 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
264 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
265 },
266 ],
267 &quot;nextPageToken&quot;: &quot;A String&quot;, # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
268 }</pre>
269 </div>
270
271 <div class="method">
272 <code class="details" id="list_next">list_next()</code>
273 <pre>Retrieves the next page of results.
274
275 Args:
276 previous_request: The request for the previous page. (required)
277 previous_response: The response from the request for the previous page. (required)
278
279 Returns:
280 A request object that you can call &#x27;execute()&#x27; on to request the next
281 page. Returns None if there are no more items in the collection.
282 </pre>
283 </div>
284
285 <div class="method">
286 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
287 <pre>Update a group.
288
289 Args:
290 name: string, The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}` (required)
291 body: object, The request body.
292 The object takes the form of:
293
294 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
295 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
296 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
297 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
298 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
299 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
300 }
301
302 updateMask: string, Optional. The list of fields to update.
303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
307
308 Returns:
309 An object of the form:
310
311 { # A group which can contain testers. A group can be invited to test apps in a Firebase project.
312 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the group.
313 &quot;inviteLinkCount&quot;: 42, # Output only. The number of invite links for this group.
314 &quot;name&quot;: &quot;A String&quot;, # The name of the group resource. Format: `projects/{project_number}/groups/{group_alias}`
315 &quot;releaseCount&quot;: 42, # Output only. The number of releases this group is permitted to access.
316 &quot;testerCount&quot;: 42, # Output only. The number of testers who are members of this group.
317 }</pre>
318 </div>
319
320 </body></html>