Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / drive_v2.apps.html
blob: 5777e6917075ac552d90d1dde197d9389eb62858 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="drive_v2.html">Drive API</a> . <a href="drive_v2.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(appId)</a></code></p>
79<p class="firstline">Gets a specific app.</p>
80<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]81 <code><a href="#list">list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Lists a user's installed apps.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(appId)</code>
86 <pre>Gets a specific app.
87
88Args:
89 appId: string, The ID of the app. (required)
90
91Returns:
92 An object of the form:
93
94 { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
95 "secondaryMimeTypes": [ # The list of secondary mime types.
96 "A String",
97 ],
98 "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
99 "installed": True or False, # Whether the app is installed.
100 "productUrl": "A String", # A link to the product listing for this app.
101 "shortDescription": "A String", # A short description of the app.
102 "id": "A String", # The ID of the app.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]103 "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104 "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
105 "primaryFileExtensions": [ # The list of primary file extensions.
106 "A String",
107 ],
108 "primaryMimeTypes": [ # The list of primary mime types.
109 "A String",
110 ],
111 "icons": [ # The various icons for the app.
112 {
113 "category": "A String", # Category of the icon. Allowed values are:
114 # - application - icon for the application
115 # - document - icon for a file associated with the app
116 # - documentShared - icon for a shared file associated with the app
117 "iconUrl": "A String", # URL for the icon.
118 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
119 },
120 ],
121 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
122 "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
123 "productId": "A String", # The ID of the product listing for this app.
124 "longDescription": "A String", # A long description of the app.
125 "supportsCreate": True or False, # Whether this app supports creating new objects.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]126 "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 "kind": "drive#app", # This is always drive#app.
128 "name": "A String", # The name of the app.
129 "createUrl": "A String", # The url to create a new file with this app.
130 "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
131 "secondaryFileExtensions": [ # The list of secondary file extensions.
132 "A String",
133 ],
134 "supportsImport": True or False, # Whether this app supports importing Google Docs.
135 "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
136 }</pre>
137</div>
138
139<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]140 <code class="details" id="list">list(languageCode=None, appFilterMimeTypes=None, appFilterExtensions=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 <pre>Lists a user's installed apps.
142
143Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]144 languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
145 appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
146 appFilterExtensions: string, A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147
148Returns:
149 An object of the form:
150
151 { # A list of third-party applications which the user has installed or given access to Google Drive.
152 "items": [ # The actual list of apps.
153 { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
154 "secondaryMimeTypes": [ # The list of secondary mime types.
155 "A String",
156 ],
157 "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
158 "installed": True or False, # Whether the app is installed.
159 "productUrl": "A String", # A link to the product listing for this app.
160 "shortDescription": "A String", # A short description of the app.
161 "id": "A String", # The ID of the app.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]162 "hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
164 "primaryFileExtensions": [ # The list of primary file extensions.
165 "A String",
166 ],
167 "primaryMimeTypes": [ # The list of primary mime types.
168 "A String",
169 ],
170 "icons": [ # The various icons for the app.
171 {
172 "category": "A String", # Category of the icon. Allowed values are:
173 # - application - icon for the application
174 # - document - icon for a file associated with the app
175 # - documentShared - icon for a shared file associated with the app
176 "iconUrl": "A String", # URL for the icon.
177 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
178 },
179 ],
180 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
181 "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
182 "productId": "A String", # The ID of the product listing for this app.
183 "longDescription": "A String", # A long description of the app.
184 "supportsCreate": True or False, # Whether this app supports creating new objects.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]185 "supportsOfflineCreate": True or False, # Whether this app supports creating new files when offline.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]186 "kind": "drive#app", # This is always drive#app.
187 "name": "A String", # The name of the app.
188 "createUrl": "A String", # The url to create a new file with this app.
189 "createInFolderTemplate": "A String", # The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
190 "secondaryFileExtensions": [ # The list of secondary file extensions.
191 "A String",
192 ],
193 "supportsImport": True or False, # Whether this app supports importing Google Docs.
194 "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
195 },
196 ],
197 "kind": "drive#appList", # This is always drive#appList.
198 "etag": "A String", # The ETag of the list.
199 "selfLink": "A String", # A link back to this list.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]200 "defaultAppIds": [ # List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
201 "A String",
202 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 }</pre>
204</div>
205
206</body></html>