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 |
|
---|
18 | namespace Google\Service\YouTube\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\YouTube\CommentThread;
|
---|
21 | use Google\Service\YouTube\CommentThreadListResponse;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "commentThreads" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $youtubeService = new Google\Service\YouTube(...);
|
---|
28 | * $commentThreads = $youtubeService->commentThreads;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class CommentThreads extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Inserts a new resource into this collection. (commentThreads.insert)
|
---|
35 | *
|
---|
36 | * @param string|array $part The *part* parameter identifies the properties that
|
---|
37 | * the API response will include. Set the parameter value to snippet. The
|
---|
38 | * snippet part has a quota cost of 2 units.
|
---|
39 | * @param CommentThread $postBody
|
---|
40 | * @param array $optParams Optional parameters.
|
---|
41 | * @return CommentThread
|
---|
42 | * @throws \Google\Service\Exception
|
---|
43 | */
|
---|
44 | public function insert($part, CommentThread $postBody, $optParams = [])
|
---|
45 | {
|
---|
46 | $params = ['part' => $part, 'postBody' => $postBody];
|
---|
47 | $params = array_merge($params, $optParams);
|
---|
48 | return $this->call('insert', [$params], CommentThread::class);
|
---|
49 | }
|
---|
50 | /**
|
---|
51 | * Retrieves a list of resources, possibly filtered.
|
---|
52 | * (commentThreads.listCommentThreads)
|
---|
53 | *
|
---|
54 | * @param string|array $part The *part* parameter specifies a comma-separated
|
---|
55 | * list of one or more commentThread resource properties that the API response
|
---|
56 | * will include.
|
---|
57 | * @param array $optParams Optional parameters.
|
---|
58 | *
|
---|
59 | * @opt_param string allThreadsRelatedToChannelId Returns the comment threads of
|
---|
60 | * all videos of the channel and the channel comments as well.
|
---|
61 | * @opt_param string channelId Returns the comment threads for all the channel
|
---|
62 | * comments (ie does not include comments left on videos).
|
---|
63 | * @opt_param string id Returns the comment threads with the given IDs for
|
---|
64 | * Stubby or Apiary.
|
---|
65 | * @opt_param string maxResults The *maxResults* parameter specifies the maximum
|
---|
66 | * number of items that should be returned in the result set.
|
---|
67 | * @opt_param string moderationStatus Limits the returned comment threads to
|
---|
68 | * those with the specified moderation status. Not compatible with the 'id'
|
---|
69 | * filter. Valid values: published, heldForReview, likelySpam.
|
---|
70 | * @opt_param string order
|
---|
71 | * @opt_param string pageToken The *pageToken* parameter identifies a specific
|
---|
72 | * page in the result set that should be returned. In an API response, the
|
---|
73 | * nextPageToken and prevPageToken properties identify other pages that could be
|
---|
74 | * retrieved.
|
---|
75 | * @opt_param string searchTerms Limits the returned comment threads to those
|
---|
76 | * matching the specified key words. Not compatible with the 'id' filter.
|
---|
77 | * @opt_param string textFormat The requested text format for the returned
|
---|
78 | * comments.
|
---|
79 | * @opt_param string videoId Returns the comment threads of the specified video.
|
---|
80 | * @return CommentThreadListResponse
|
---|
81 | * @throws \Google\Service\Exception
|
---|
82 | */
|
---|
83 | public function listCommentThreads($part, $optParams = [])
|
---|
84 | {
|
---|
85 | $params = ['part' => $part];
|
---|
86 | $params = array_merge($params, $optParams);
|
---|
87 | return $this->call('list', [$params], CommentThreadListResponse::class);
|
---|
88 | }
|
---|
89 | }
|
---|
90 |
|
---|
91 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
92 | class_alias(CommentThreads::class, 'Google_Service_YouTube_Resource_CommentThreads');
|
---|