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