Debian Codegraph @

docs/dyn/firebaseappdistribution_v1.projects.testers.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.testers.html">testers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#batchAdd">batchAdd(project, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Batch adds testers. This call adds testers for the specified emails if they don't already exist. Returns all testers specified in the request, including newly created and previously existing testers. This action is idempotent.</p>
80 <p class="toc_element">
81 <code><a href="#batchRemove">batchRemove(project, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists testers and their resource ids.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Update a tester. If the testers joins a group they gain access to all releases that the group has access to.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="batchAdd">batchAdd(project, body=None, x__xgafv=None)</code>
98 <pre>Batch adds testers. This call adds testers for the specified emails if they don&#x27;t already exist. Returns all testers specified in the request, including newly created and previously existing testers. This action is idempotent.
99
100 Args:
101 project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
102 body: object, The request body.
103 The object takes the form of:
104
105 { # The Request message for batch adding testers
106 &quot;emails&quot;: [ # Required. The email addresses of the tester resources to create. A maximum of 999 and a minimum of 1 tester can be created in a batch.
107 &quot;A String&quot;,
108 ],
109 }
110
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 { # The Response message for `BatchAddTesters`.
120 &quot;testers&quot;: [ # The testers which are created and/or already exist
121 { # A person that can be invited to test apps in a Firebase project.
122 &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
123 &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
124 &quot;A String&quot;,
125 ],
126 &quot;lastActivityTime&quot;: &quot;A String&quot;, # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they&#x27;ve never installed one or if the release no longer exists, this is the time the tester was added to the project.
127 &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
128 },
129 ],
130 }</pre>
131 </div>
132
133 <div class="method">
134 <code class="details" id="batchRemove">batchRemove(project, body=None, x__xgafv=None)</code>
135 <pre>Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.
136
137 Args:
138 project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
139 body: object, The request body.
140 The object takes the form of:
141
142 { # The request message for `BatchRemoveTesters`.
143 &quot;emails&quot;: [ # Required. The email addresses of the tester resources to removed. A maximum of 999 and a minimum of 1 testers can be deleted 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 { # The response message for `BatchRemoveTesters`
157 &quot;emails&quot;: [ # List of deleted tester emails
158 &quot;A String&quot;,
159 ],
160 }</pre>
161 </div>
162
163 <div class="method">
164 <code class="details" id="close">close()</code>
165 <pre>Close httplib2 connections.</pre>
166 </div>
167
168 <div class="method">
169 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
170 <pre>Lists testers and their resource ids.
171
172 Args:
173 parent: string, Required. The name of the project resource, which is the parent of the tester resources. Format: `projects/{project_number}` (required)
174 filter: string, Optional. The expression to filter testers listed in the response. To learn more about filtering, refer to [Google&#x27;s AIP-160 standard](http://aip.dev/160). Supported fields: - `name` - `displayName` - `groups` Example: - `name = &quot;projects/-/testers/*@example.com&quot;` - `displayName = &quot;Joe Sixpack&quot;` - `groups = &quot;projects/*/groups/qa-team&quot;`
175 pageSize: integer, Optional. The maximum number of testers to return. The service may return fewer than this value. The valid range is [1-1000]; If unspecified (0), at most 10 testers are returned. Values above 1000 are coerced to 1000.
176 pageToken: string, Optional. A page token, received from a previous `ListTesters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTesters` must match the call that provided the page token.
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182 Returns:
183 An object of the form:
184
185 { # The response message for `ListTesters`.
186 &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.
187 &quot;testers&quot;: [ # The testers listed.
188 { # A person that can be invited to test apps in a Firebase project.
189 &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
190 &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
191 &quot;A String&quot;,
192 ],
193 &quot;lastActivityTime&quot;: &quot;A String&quot;, # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they&#x27;ve never installed one or if the release no longer exists, this is the time the tester was added to the project.
194 &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
195 },
196 ],
197 }</pre>
198 </div>
199
200 <div class="method">
201 <code class="details" id="list_next">list_next()</code>
202 <pre>Retrieves the next page of results.
203
204 Args:
205 previous_request: The request for the previous page. (required)
206 previous_response: The response from the request for the previous page. (required)
207
208 Returns:
209 A request object that you can call &#x27;execute()&#x27; on to request the next
210 page. Returns None if there are no more items in the collection.
211 </pre>
212 </div>
213
214 <div class="method">
215 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
216 <pre>Update a tester. If the testers joins a group they gain access to all releases that the group has access to.
217
218 Args:
219 name: string, The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}` (required)
220 body: object, The request body.
221 The object takes the form of:
222
223 { # A person that can be invited to test apps in a Firebase project.
224 &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
225 &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
226 &quot;A String&quot;,
227 ],
228 &quot;lastActivityTime&quot;: &quot;A String&quot;, # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they&#x27;ve never installed one or if the release no longer exists, this is the time the tester was added to the project.
229 &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
230 }
231
232 updateMask: string, Optional. The list of fields to update.
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238 Returns:
239 An object of the form:
240
241 { # A person that can be invited to test apps in a Firebase project.
242 &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
243 &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
244 &quot;A String&quot;,
245 ],
246 &quot;lastActivityTime&quot;: &quot;A String&quot;, # Output only. The time the tester was last active. This is the most recent time the tester installed one of the apps. If they&#x27;ve never installed one or if the release no longer exists, this is the time the tester was added to the project.
247 &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
248 }</pre>
249 </div>
250
251 </body></html>