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