source: vendor/google/apiclient-services/src/YouTube/Resource/PlaylistImages.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 6 weeks ago

Upload project files

  • Property mode set to 100644
File size: 9.2 KB
Line 
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\YouTube\Resource;
19
20use Google\Service\YouTube\PlaylistImage;
21use Google\Service\YouTube\PlaylistImageListResponse;
22
23/**
24 * The "playlistImages" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $youtubeService = new Google\Service\YouTube(...);
28 * $playlistImages = $youtubeService->playlistImages;
29 * </code>
30 */
31class PlaylistImages extends \Google\Service\Resource
32{
33 /**
34 * Deletes a resource. (playlistImages.delete)
35 *
36 * @param array $optParams Optional parameters.
37 *
38 * @opt_param string id Id to identify this image. This is returned from by the
39 * List method.
40 * @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
41 * exclusively for YouTube content partners. The *onBehalfOfContentOwner*
42 * parameter indicates that the request's authorization credentials identify a
43 * YouTube CMS user who is acting on behalf of the content owner specified in
44 * the parameter value. This parameter is intended for YouTube content partners
45 * that own and manage many different YouTube channels. It allows content owners
46 * to authenticate once and get access to all their video and channel data,
47 * without having to provide authentication credentials for each individual
48 * channel. The CMS account that the user authenticates with must be linked to
49 * the specified YouTube content owner.
50 * @throws \Google\Service\Exception
51 */
52 public function delete($optParams = [])
53 {
54 $params = [];
55 $params = array_merge($params, $optParams);
56 return $this->call('delete', [$params]);
57 }
58 /**
59 * Inserts a new resource into this collection. (playlistImages.insert)
60 *
61 * @param PlaylistImage $postBody
62 * @param array $optParams Optional parameters.
63 *
64 * @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
65 * exclusively for YouTube content partners. The *onBehalfOfContentOwner*
66 * parameter indicates that the request's authorization credentials identify a
67 * YouTube CMS user who is acting on behalf of the content owner specified in
68 * the parameter value. This parameter is intended for YouTube content partners
69 * that own and manage many different YouTube channels. It allows content owners
70 * to authenticate once and get access to all their video and channel data,
71 * without having to provide authentication credentials for each individual
72 * channel. The CMS account that the user authenticates with must be linked to
73 * the specified YouTube content owner.
74 * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
75 * used in a properly authorized request. *Note:* This parameter is intended
76 * exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
77 * parameter specifies the YouTube channel ID of the channel to which a video is
78 * being added. This parameter is required when a request specifies a value for
79 * the onBehalfOfContentOwner parameter, and it can only be used in conjunction
80 * with that parameter. In addition, the request must be authorized using a CMS
81 * account that is linked to the content owner that the onBehalfOfContentOwner
82 * parameter specifies. Finally, the channel that the
83 * onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
84 * content owner that the onBehalfOfContentOwner parameter specifies. This
85 * parameter is intended for YouTube content partners that own and manage many
86 * different YouTube channels. It allows content owners to authenticate once and
87 * perform actions on behalf of the channel specified in the parameter value,
88 * without having to provide authentication credentials for each separate
89 * channel.
90 * @opt_param string part The *part* parameter specifies the properties that the
91 * API response will include.
92 * @return PlaylistImage
93 * @throws \Google\Service\Exception
94 */
95 public function insert(PlaylistImage $postBody, $optParams = [])
96 {
97 $params = ['postBody' => $postBody];
98 $params = array_merge($params, $optParams);
99 return $this->call('insert', [$params], PlaylistImage::class);
100 }
101 /**
102 * Retrieves a list of resources, possibly filtered.
103 * (playlistImages.listPlaylistImages)
104 *
105 * @param array $optParams Optional parameters.
106 *
107 * @opt_param string maxResults The *maxResults* parameter specifies the maximum
108 * number of items that should be returned in the result set.
109 * @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
110 * exclusively for YouTube content partners. The *onBehalfOfContentOwner*
111 * parameter indicates that the request's authorization credentials identify a
112 * YouTube CMS user who is acting on behalf of the content owner specified in
113 * the parameter value. This parameter is intended for YouTube content partners
114 * that own and manage many different YouTube channels. It allows content owners
115 * to authenticate once and get access to all their video and channel data,
116 * without having to provide authentication credentials for each individual
117 * channel. The CMS account that the user authenticates with must be linked to
118 * the specified YouTube content owner.
119 * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
120 * used in a properly authorized request. *Note:* This parameter is intended
121 * exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
122 * parameter specifies the YouTube channel ID of the channel to which a video is
123 * being added. This parameter is required when a request specifies a value for
124 * the onBehalfOfContentOwner parameter, and it can only be used in conjunction
125 * with that parameter. In addition, the request must be authorized using a CMS
126 * account that is linked to the content owner that the onBehalfOfContentOwner
127 * parameter specifies. Finally, the channel that the
128 * onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
129 * content owner that the onBehalfOfContentOwner parameter specifies. This
130 * parameter is intended for YouTube content partners that own and manage many
131 * different YouTube channels. It allows content owners to authenticate once and
132 * perform actions on behalf of the channel specified in the parameter value,
133 * without having to provide authentication credentials for each separate
134 * channel.
135 * @opt_param string pageToken The *pageToken* parameter identifies a specific
136 * page in the result set that should be returned. In an API response, the
137 * nextPageToken and prevPageToken properties identify other pages that could be
138 * retrieved.
139 * @opt_param string parent Return PlaylistImages for this playlist id.
140 * @opt_param string part The *part* parameter specifies a comma-separated list
141 * of one or more playlistImage resource properties that the API response will
142 * include. If the parameter identifies a property that contains child
143 * properties, the child properties will be included in the response.
144 * @return PlaylistImageListResponse
145 * @throws \Google\Service\Exception
146 */
147 public function listPlaylistImages($optParams = [])
148 {
149 $params = [];
150 $params = array_merge($params, $optParams);
151 return $this->call('list', [$params], PlaylistImageListResponse::class);
152 }
153 /**
154 * Updates an existing resource. (playlistImages.update)
155 *
156 * @param PlaylistImage $postBody
157 * @param array $optParams Optional parameters.
158 *
159 * @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
160 * exclusively for YouTube content partners. The *onBehalfOfContentOwner*
161 * parameter indicates that the request's authorization credentials identify a
162 * YouTube CMS user who is acting on behalf of the content owner specified in
163 * the parameter value. This parameter is intended for YouTube content partners
164 * that own and manage many different YouTube channels. It allows content owners
165 * to authenticate once and get access to all their video and channel data,
166 * without having to provide authentication credentials for each individual
167 * channel. The CMS account that the user authenticates with must be linked to
168 * the specified YouTube content owner.
169 * @opt_param string part The *part* parameter specifies the properties that the
170 * API response will include.
171 * @return PlaylistImage
172 * @throws \Google\Service\Exception
173 */
174 public function update(PlaylistImage $postBody, $optParams = [])
175 {
176 $params = ['postBody' => $postBody];
177 $params = array_merge($params, $optParams);
178 return $this->call('update', [$params], PlaylistImage::class);
179 }
180}
181
182// Adding a class alias for backwards compatibility with the previous class name.
183class_alias(PlaylistImages::class, 'Google_Service_YouTube_Resource_PlaylistImages');
Note: See TracBrowser for help on using the repository browser.