File: firebaseappdistribution_v1.projects.testers.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (251 lines) | stat: -rw-r--r-- 10,712 bytes parent folder | download
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<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="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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#batchAdd">batchAdd(project, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
  <code><a href="#batchRemove">batchRemove(project, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists testers and their resource ids.</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>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="batchAdd">batchAdd(project, body=None, x__xgafv=None)</code>
  <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.

Args:
  project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The Request message for batch adding testers
  &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.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Response message for `BatchAddTesters`.
  &quot;testers&quot;: [ # The testers which are created and/or already exist
    { # A person that can be invited to test apps in a Firebase project.
      &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
      &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
        &quot;A String&quot;,
      ],
      &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.
      &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="batchRemove">batchRemove(project, body=None, x__xgafv=None)</code>
  <pre>Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers.

Args:
  project: string, Required. The name of the project resource. Format: `projects/{project_number}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for `BatchRemoveTesters`.
  &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.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `BatchRemoveTesters`
  &quot;emails&quot;: [ # List of deleted tester emails
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists testers and their resource ids.

Args:
  parent: string, Required. The name of the project resource, which is the parent of the tester resources. Format: `projects/{project_number}` (required)
  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;`
  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.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for `ListTesters`.
  &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.
  &quot;testers&quot;: [ # The testers listed.
    { # A person that can be invited to test apps in a Firebase project.
      &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
      &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
        &quot;A String&quot;,
      ],
      &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.
      &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
    },
  ],
}</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>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update a tester. If the testers joins a group they gain access to all releases that the group has access to.

Args:
  name: string, The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A person that can be invited to test apps in a Firebase project.
  &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
  &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
    &quot;A String&quot;,
  ],
  &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.
  &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
}

  updateMask: string, Optional. The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A person that can be invited to test apps in a Firebase project.
  &quot;displayName&quot;: &quot;A String&quot;, # The name of the tester associated with the Google account used to accept the tester invitation.
  &quot;groups&quot;: [ # The resource names of the groups this tester belongs to.
    &quot;A String&quot;,
  ],
  &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.
  &quot;name&quot;: &quot;A String&quot;, # The name of the tester resource. Format: `projects/{project_number}/testers/{email_address}`
}</pre>
</div>

</body></html>