Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / dyn / drive_v2.apps.html
blob: 000d852be0af77552c92be1e7fa046a417419bc2 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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">
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]78 <code><a href="#get">get(appId)</a></code></p>
79<p class="firstline">Gets a specific app.</p>
80<p class="toc_element">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]81 <code><a href="#list">list()</a></code></p>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]82<p class="firstline">Lists a user's installed apps.</p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]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
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]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.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]95 "kind": "drive#app", # This is always drive#app.
96 "primaryFileExtensions": [ # The list of primary file extensions.
97 "A String",
98 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]99 "secondaryMimeTypes": [ # The list of secondary mime types.
100 "A String",
101 ],
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]102 "name": "A String", # The name of the app.
103 "icons": [ # The various icons for the app.
104 {
105 "category": "A String", # Category of the icon. Allowed values are:
106 # - application - icon for the application
107 # - document - icon for a file associated with the app
108 # - documentShared - icon for a shared file associated with the app
109 "iconUrl": "A String", # URL for the icon.
110 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
111 },
112 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]113 "shortDescription": "A String", # A short description of the app.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]114 "secondaryFileExtensions": [ # The list of secondary file extensions.
115 "A String",
116 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]117 "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]118 "installed": True or False, # Whether the app is installed.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]119 "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
120 "productUrl": "A String", # A link to the product listing for this app.
121 "productId": "A String", # The ID of the product listing for this app.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]122 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
123 "supportsCreate": True or False, # Whether this app supports creating new objects.
124 "supportsImport": True or False, # Whether this app supports importing Google Docs.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]125 "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.
126 "longDescription": "A String", # A long description of the app.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]127 "primaryMimeTypes": [ # The list of primary mime types.
128 "A String",
129 ],
130 "id": "A String", # The ID of the app.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]131 "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]132 }</pre>
133</div>
134
135<div class="method">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]136 <code class="details" id="list">list()</code>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]137 <pre>Lists a user's installed apps.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]138
139Args:
140
141Returns:
142 An object of the form:
143
144 { # A list of third-party applications which the user has installed or given access to Google Drive.
145 "items": [ # The actual list of apps.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]146 { # 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]147 "kind": "drive#app", # This is always drive#app.
148 "primaryFileExtensions": [ # The list of primary file extensions.
149 "A String",
150 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]151 "secondaryMimeTypes": [ # The list of secondary mime types.
152 "A String",
153 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]154 "name": "A String", # The name of the app.
155 "icons": [ # The various icons for the app.
156 {
157 "category": "A String", # Category of the icon. Allowed values are:
158 # - application - icon for the application
159 # - document - icon for a file associated with the app
160 # - documentShared - icon for a shared file associated with the app
161 "iconUrl": "A String", # URL for the icon.
162 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
163 },
164 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]165 "shortDescription": "A String", # A short description of the app.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]166 "secondaryFileExtensions": [ # The list of secondary file extensions.
167 "A String",
168 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]169 "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]170 "installed": True or False, # Whether the app is installed.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]171 "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
172 "productUrl": "A String", # A link to the product listing for this app.
173 "productId": "A String", # The ID of the product listing for this app.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]174 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
175 "supportsCreate": True or False, # Whether this app supports creating new objects.
176 "supportsImport": True or False, # Whether this app supports importing Google Docs.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]177 "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.
178 "longDescription": "A String", # A long description of the app.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]179 "primaryMimeTypes": [ # The list of primary mime types.
180 "A String",
181 ],
182 "id": "A String", # The ID of the app.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]183 "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]184 },
185 ],
186 "kind": "drive#appList", # This is always drive#appList.
187 "etag": "A String", # The ETag of the list.
188 "selfLink": "A String", # A link back to this list.
189 }</pre>
190</div>
191
192</body></html>