Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / androidmanagement_v1.enterprises.webApps.html
blob: 1c8e7d58e64a5d50adb0ef23f9ebe7efb77040c5 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="androidmanagement_v1.html">Android Management API</a> . <a href="androidmanagement_v1.enterprises.html">enterprises</a> . <a href="androidmanagement_v1.enterprises.webApps.html">webApps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a web app.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a web app.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a web app.</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 web apps for a given enterprise.</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, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a web app.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
98 <pre>Creates a web app.
99
100Args:
101 parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # A web app.
106 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
107 "icons": [ # A list of icons for the web app. Must have at least one element.
108 { # An icon for a web app. Supported formats are: png, jpg and webp.
109 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
110 },
111 ],
112 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
113 "displayMode": "A String", # The display mode of the web app.
114 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
115 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
116 }
117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
126 { # A web app.
127 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
128 "icons": [ # A list of icons for the web app. Must have at least one element.
129 { # An icon for a web app. Supported formats are: png, jpg and webp.
130 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
131 },
132 ],
133 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
134 "displayMode": "A String", # The display mode of the web app.
135 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
136 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
137 }</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
142 <pre>Deletes a web app.
143
144Args:
145 name: string, The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. (required)
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
154 { # 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:
155 # service Foo {
156 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
157 # }
158 # The JSON representation for Empty is empty JSON object {}.
159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="get">get(name, x__xgafv=None)</code>
164 <pre>Gets a web app.
165
166Args:
167 name: string, The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}. (required)
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
176 { # A web app.
177 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
178 "icons": [ # A list of icons for the web app. Must have at least one element.
179 { # An icon for a web app. Supported formats are: png, jpg and webp.
180 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
181 },
182 ],
183 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
184 "displayMode": "A String", # The display mode of the web app.
185 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
186 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
192 <pre>Lists web apps for a given enterprise.
193
194Args:
195 parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
196 pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value.
197 pageToken: string, A token identifying a page of results returned by the server.
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 An object of the form:
205
206 { # Response to a request to list web apps for a given enterprise.
207 "nextPageToken": "A String", # If there are more results, a token to retrieve next page of results.
208 "webApps": [ # The list of web apps.
209 { # A web app.
210 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
211 "icons": [ # A list of icons for the web app. Must have at least one element.
212 { # An icon for a web app. Supported formats are: png, jpg and webp.
213 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
214 },
215 ],
216 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
217 "displayMode": "A String", # The display mode of the web app.
218 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
219 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
220 },
221 ],
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
227 <pre>Retrieves the next page of results.
228
229Args:
230 previous_request: The request for the previous page. (required)
231 previous_response: The response from the request for the previous page. (required)
232
233Returns:
234 A request object that you can call 'execute()' on to request the next
235 page. Returns None if there are no more items in the collection.
236 </pre>
237</div>
238
239<div class="method">
240 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
241 <pre>Updates a web app.
242
243Args:
244 name: string, The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. (required)
245 body: object, The request body. (required)
246 The object takes the form of:
247
248{ # A web app.
249 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
250 "icons": [ # A list of icons for the web app. Must have at least one element.
251 { # An icon for a web app. Supported formats are: png, jpg and webp.
252 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
253 },
254 ],
255 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
256 "displayMode": "A String", # The display mode of the web app.
257 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
258 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
259 }
260
261 updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
270 { # A web app.
271 "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
272 "icons": [ # A list of icons for the web app. Must have at least one element.
273 { # An icon for a web app. Supported formats are: png, jpg and webp.
274 "imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
275 },
276 ],
277 "title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
278 "displayMode": "A String", # The display mode of the web app.
279 "versionCode": "A String", # The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
280 "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
281 }</pre>
282</div>
283
284</body></html>