blob: 27f5594d1fb8e3af124d84de5c87b8c34a2658aa [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -04001<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 -040078 <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 -040081 <code><a href="#list">list()</a></code></p>
82<p class="firstline">Lists a user's apps.</p>
83<h3>Method Details</h3>
84<div class="method">
Joe Gregorioad8013f2012-08-03 08:44:02 -040085 <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 { # Information about a third-party application which the user has installed or given access to Google Drive.
95 "kind": "drive#app", # This is always drive#app.
96 "primaryFileExtensions": [ # The list of primary file extensions.
97 "A String",
98 ],
99 "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
100 "name": "A String", # The name of the app.
101 "icons": [ # The various icons for the app.
102 {
103 "category": "A String", # Category of the icon. Allowed values are:
104 # - application - icon for the application
105 # - document - icon for a file associated with the app
106 # - documentShared - icon for a shared file associated with the app
107 "iconUrl": "A String", # URL for the icon.
108 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
109 },
110 ],
111 "secondaryFileExtensions": [ # The list of secondary file extensions.
112 "A String",
113 ],
114 "installed": True or False, # Whether the app is installed.
115 "productUrl": "A String", # The product URL.
116 "secondaryMimeTypes": [ # The list of secondary mime types.
117 "A String",
118 ],
119 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
120 "supportsCreate": True or False, # Whether this app supports creating new objects.
121 "supportsImport": True or False, # Whether this app supports importing Google Docs.
122 "primaryMimeTypes": [ # The list of primary mime types.
123 "A String",
124 ],
125 "id": "A String", # The ID of the app.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400126 "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 -0400127 }</pre>
128</div>
129
130<div class="method">
Joe Gregorio075572b2012-07-09 16:53:09 -0400131 <code class="details" id="list">list()</code>
132 <pre>Lists a user's apps.
133
134Args:
135
136Returns:
137 An object of the form:
138
139 { # A list of third-party applications which the user has installed or given access to Google Drive.
140 "items": [ # The actual list of apps.
141 { # Information about a third-party application which the user has installed or given access to Google Drive.
142 "kind": "drive#app", # This is always drive#app.
143 "primaryFileExtensions": [ # The list of primary file extensions.
144 "A String",
145 ],
Joe Gregorioad8013f2012-08-03 08:44:02 -0400146 "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 -0400147 "name": "A String", # The name of the app.
148 "icons": [ # The various icons for the app.
149 {
150 "category": "A String", # Category of the icon. Allowed values are:
151 # - application - icon for the application
152 # - document - icon for a file associated with the app
153 # - documentShared - icon for a shared file associated with the app
154 "iconUrl": "A String", # URL for the icon.
155 "size": 42, # Size of the icon. Represented as the maximum of the width and height.
156 },
157 ],
158 "secondaryFileExtensions": [ # The list of secondary file extensions.
159 "A String",
160 ],
161 "installed": True or False, # Whether the app is installed.
162 "productUrl": "A String", # The product URL.
163 "secondaryMimeTypes": [ # The list of secondary mime types.
164 "A String",
165 ],
166 "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
167 "supportsCreate": True or False, # Whether this app supports creating new objects.
168 "supportsImport": True or False, # Whether this app supports importing Google Docs.
169 "primaryMimeTypes": [ # The list of primary mime types.
170 "A String",
171 ],
172 "id": "A String", # The ID of the app.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400173 "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 -0400174 },
175 ],
176 "kind": "drive#appList", # This is always drive#appList.
177 "etag": "A String", # The ETag of the list.
178 "selfLink": "A String", # A link back to this list.
179 }</pre>
180</div>
181
182</body></html>