1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Keep\Resource;
19
20use Google\Service\Keep\Attachment;
21
22/**
23 * The "media" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $keepService = new Google\Service\Keep(...);
27 *   $media = $keepService->media;
28 *  </code>
29 */
30class Media extends \Google\Service\Resource
31{
32  /**
33   * Gets an attachment. To download attachment media via REST requires the
34   * alt=media query parameter. Returns a 400 bad request error if attachment
35   * media is not available in the requested MIME type. (media.download)
36   *
37   * @param string $name Required. The name of the attachment.
38   * @param array $optParams Optional parameters.
39   *
40   * @opt_param string mimeType The IANA MIME type format requested. The requested
41   * MIME type must be one specified in the attachment.mime_type. Required when
42   * downloading attachment media and ignored otherwise.
43   * @return Attachment
44   */
45  public function download($name, $optParams = [])
46  {
47    $params = ['name' => $name];
48    $params = array_merge($params, $optParams);
49    return $this->call('download', [$params], Attachment::class);
50  }
51}
52
53// Adding a class alias for backwards compatibility with the previous class name.
54class_alias(Media::class, 'Google_Service_Keep_Resource_Media');
55