Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / firebase_v1beta1.projects.iosApps.html
blob: 7ada4664c52380a13ff035c3b9c70b7bc528e178 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.iosApps.html">iosApps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Requests that a new IosApp be created.</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the IosApp identified by the specified resource name.</p>
83<p class="toc_element">
84 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the configuration artifact associated with the specified IosApp.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists each IosApp associated with the specified parent Project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</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">Updates the attributes of the IosApp identified by the specified</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
98 <pre>Requests that a new IosApp be created.
99&lt;br&gt;
100&lt;br&gt;The result of this call is an `Operation` which can be used to track
101the provisioning process. The `Operation` is automatically deleted after
102completion, so there is no need to call `DeleteOperation`.
103
104Args:
105 parent: string, The parent Project in which to create an App, in the format:
106&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;&lt;/code&gt; (required)
107 body: object, The request body.
108 The object takes the form of:
109
110{ # Details of a Firebase App for iOS.
111 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
112 &quot;bundleId&quot;: &quot;A String&quot;, # The canonical bundle ID of the iOS App as it would appear in the iOS
113 # AppStore.
114 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the App by Apple in the
115 # iOS App Store.
116 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
117 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
118 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
119 # &lt;br&gt;
120 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
121 # format is not specified.
122 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
123}
124
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # This resource represents a long-running operation that is the result of a
134 # network API call.
135 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
136 # If `true`, the operation is completed, and either `error` or `response` is
137 # available.
138 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
139 # method returns no data on success, such as `Delete`, the response is
140 # `google.protobuf.Empty`. If the original method is standard
141 # `Get`/`Create`/`Update`, the response should be the resource. For other
142 # methods, the response should have the type `XxxResponse`, where `Xxx`
143 # is the original method name. For example, if the original method name
144 # is `TakeSnapshot()`, the inferred response type is
145 # `TakeSnapshotResponse`.
146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
147 },
148 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
149 # originally returns it. If you use the default HTTP mapping, the
150 # `name` should be a resource name ending with `operations/{unique_id}`.
151 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
152 # different programming environments, including REST APIs and RPC APIs. It is
153 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
154 # three pieces of data: error code, error message, and error details.
155 #
156 # You can find out more about this error model and how to work with it in the
157 # [API Design Guide](https://cloud.google.com/apis/design/errors).
158 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
159 # user-facing error message should be localized and sent in the
160 # google.rpc.Status.details field, or localized by the client.
161 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
162 # message types for APIs to use.
163 {
164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
166 ],
167 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
168 },
169 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
170 # contains progress information and common metadata such as create time.
171 # Some services might not provide such metadata. Any method that returns a
172 # long-running operation should document the metadata type, if any.
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="get">get(name, x__xgafv=None)</code>
180 <pre>Gets the IosApp identified by the specified resource name.
181
182Args:
183 name: string, The fully qualified resource name of the App, in the format:
184&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
185&lt;br&gt;As an &lt;var&gt;appId&lt;/var&gt; is a unique identifier, the Unique Resource
186from Sub-Collection access pattern may be used here, in the format:
187&lt;br&gt;&lt;code&gt;projects/-/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt; (required)
188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # Details of a Firebase App for iOS.
197 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
198 &quot;bundleId&quot;: &quot;A String&quot;, # The canonical bundle ID of the iOS App as it would appear in the iOS
199 # AppStore.
200 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the App by Apple in the
201 # iOS App Store.
202 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
203 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
204 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
205 # &lt;br&gt;
206 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
207 # format is not specified.
208 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
209 }</pre>
210</div>
211
212<div class="method">
213 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
214 <pre>Gets the configuration artifact associated with the specified IosApp.
215
216Args:
217 name: string, The resource name of the App configuration to download, in the format:
218&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;/config&lt;/code&gt;
219&lt;br&gt;As an &lt;var&gt;appId&lt;/var&gt; is a unique identifier, the Unique Resource
220from Sub-Collection access pattern may be used here, in the format:
221&lt;br&gt;&lt;code&gt;projects/-/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt; (required)
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
230 { # Configuration metadata of a single Firebase App for iOS.
231 &quot;configFileContents&quot;: &quot;A String&quot;, # The content of the XML configuration file.
232 &quot;configFilename&quot;: &quot;A String&quot;, # The filename that the configuration artifact is typically saved as.
233 # &lt;br&gt;For example: `GoogleService-Info.plist`
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
239 <pre>Lists each IosApp associated with the specified parent Project.
240&lt;br&gt;
241&lt;br&gt;The elements are returned in no particular order, but will be a
242consistent view of the Apps when additional requests are made with a
243`pageToken`.
244
245Args:
246 parent: string, The parent Project for which to list Apps, in the format:
247&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;&lt;/code&gt; (required)
248 pageSize: integer, The maximum number of Apps to return in the response.
249&lt;br&gt;
250&lt;br&gt;The server may return fewer than this at its discretion.
251If no value is specified (or too large a value is specified), the server
252will impose its own limit.
253 pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in
254the set of Apps to resume listing.
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 {
264 &quot;apps&quot;: [ # List of each IosApp that is in the parent Firebase Project.
265 { # Details of a Firebase App for iOS.
266 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
267 &quot;bundleId&quot;: &quot;A String&quot;, # The canonical bundle ID of the iOS App as it would appear in the iOS
268 # AppStore.
269 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the App by Apple in the
270 # iOS App Store.
271 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
272 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
273 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
274 # &lt;br&gt;
275 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
276 # format is not specified.
277 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
278 },
279 ],
280 &quot;nextPageToken&quot;: &quot;A String&quot;, # If the result list is too large to fit in a single response, then a token
281 # is returned. If the string is empty, then this response is the last page of
282 # results.
283 # &lt;br&gt;
284 # &lt;br&gt;This token can be used in a subsequent call to `ListIosApps` to find
285 # the next group of Apps.
286 # &lt;br&gt;
287 # &lt;br&gt;Page tokens are short-lived and should not be persisted.
288 }</pre>
289</div>
290
291<div class="method">
292 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
293 <pre>Retrieves the next page of results.
294
295Args:
296 previous_request: The request for the previous page. (required)
297 previous_response: The response from the request for the previous page. (required)
298
299Returns:
300 A request object that you can call &#x27;execute()&#x27; on to request the next
301 page. Returns None if there are no more items in the collection.
302 </pre>
303</div>
304
305<div class="method">
306 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
307 <pre>Updates the attributes of the IosApp identified by the specified
308resource name.
309
310Args:
311 name: string, The fully qualified resource name of the App, in the format:
312&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt; (required)
313 body: object, The request body.
314 The object takes the form of:
315
316{ # Details of a Firebase App for iOS.
317 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
318 &quot;bundleId&quot;: &quot;A String&quot;, # The canonical bundle ID of the iOS App as it would appear in the iOS
319 # AppStore.
320 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the App by Apple in the
321 # iOS App Store.
322 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
323 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
324 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
325 # &lt;br&gt;
326 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
327 # format is not specified.
328 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
329}
330
331 updateMask: string, Specifies which fields to update.
332&lt;br&gt;Note that the fields `name`, `appId`, `projectId`, and `bundleId`
333are all immutable.
334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
338
339Returns:
340 An object of the form:
341
342 { # Details of a Firebase App for iOS.
343 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the App.
344 &quot;bundleId&quot;: &quot;A String&quot;, # The canonical bundle ID of the iOS App as it would appear in the iOS
345 # AppStore.
346 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the App by Apple in the
347 # iOS App Store.
348 &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the App, in the format:
349 # &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;projectId&lt;/var&gt;/iosApps/&lt;var&gt;appId&lt;/var&gt;&lt;/code&gt;
350 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier of the App.
351 # &lt;br&gt;
352 # &lt;br&gt;This identifier should be treated as an opaque token, as the data
353 # format is not specified.
354 &quot;projectId&quot;: &quot;A String&quot;, # The globally unique, user-assigned ID of the parent Project for the App.
355 }</pre>
356</div>
357
358</body></html>