Debian Codegraph @

docs/dyn/chat_v1.media.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="chat_v1.html">Google Chat API</a> . <a href="chat_v1.media.html">media</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#download">download(resourceName, x__xgafv=None)</a></code></p>
82 <p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
83 <p class="toc_element">
84 <code><a href="#download_media">download_media(resourceName, x__xgafv=None)</a></code></p>
85 <p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
86 <p class="toc_element">
87 <code><a href="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="download">download(resourceName, x__xgafv=None)</code>
97 <pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.
98
99 Args:
100 resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # Media resource.
110 &quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
111 }</pre>
112 </div>
113
114 <div class="method">
115 <code class="details" id="download_media">download_media(resourceName, x__xgafv=None)</code>
116 <pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.
117
118 Args:
119 resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 The media object as a string.
127
128 </pre>
129 </div>
130
131 <div class="method">
132 <code class="details" id="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
133 <pre>Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren&#x27;t supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&amp;co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
134
135 Args:
136 parent: string, Required. Resource name of the Chat space in which the attachment is uploaded. Format &quot;spaces/{space}&quot;. (required)
137 body: object, The request body.
138 The object takes the form of:
139
140 { # Request to upload an attachment.
141 &quot;filename&quot;: &quot;A String&quot;, # Required. The filename of the attachment, including the file extension.
142 }
143
144 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
145 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151 Returns:
152 An object of the form:
153
154 { # Response of uploading an attachment.
155 &quot;attachmentDataRef&quot;: { # A reference to the attachment data. # Reference to the uploaded attachment.
156 &quot;attachmentUploadToken&quot;: &quot;A String&quot;, # Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.
157 &quot;resourceName&quot;: &quot;A String&quot;, # Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
158 },
159 }</pre>
160 </div>
161
162 </body></html>