📂 File Browser

📁 Directories

📄 Files

📄 Source: LiveChatModerators.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\YouTube\Resource;

use Google\Service\YouTube\LiveChatModerator;
use Google\Service\YouTube\LiveChatModeratorListResponse;

/**
 * The "liveChatModerators" collection of methods.
 * Typical usage is:
 *  <code>
 *   $youtubeService = new Google\Service\YouTube(...);
 *   $liveChatModerators = $youtubeService->liveChatModerators;
 *  </code>
 */
class LiveChatModerators extends \Google\Service\Resource
{
  /**
   * Deletes a chat moderator. (liveChatModerators.delete)
   *
   * @param string $id
   * @param array $optParams Optional parameters.
   * @throws \Google\Service\Exception
   */
  public function delete($id, $optParams = [])
  {
    $params = ['id' => $id];
    $params = array_merge($params, $optParams);
    return $this->call('delete', [$params]);
  }
  /**
   * Inserts a new resource into this collection. (liveChatModerators.insert)
   *
   * @param string|array $part The *part* parameter serves two purposes in this
   * operation. It identifies the properties that the write operation will set as
   * well as the properties that the API response returns. Set the parameter value
   * to snippet.
   * @param LiveChatModerator $postBody
   * @param array $optParams Optional parameters.
   * @return LiveChatModerator
   * @throws \Google\Service\Exception
   */
  public function insert($part, LiveChatModerator $postBody, $optParams = [])
  {
    $params = ['part' => $part, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('insert', [$params], LiveChatModerator::class);
  }
  /**
   * Retrieves a list of resources, possibly filtered.
   * (liveChatModerators.listLiveChatModerators)
   *
   * @param string $liveChatId The id of the live chat for which moderators should
   * be returned.
   * @param string|array $part The *part* parameter specifies the
   * liveChatModerator resource parts that the API response will include.
   * Supported values are id and snippet.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string maxResults The *maxResults* parameter specifies the maximum
   * number of items that should be returned in the result set.
   * @opt_param string pageToken The *pageToken* parameter identifies a specific
   * page in the result set that should be returned. In an API response, the
   * nextPageToken and prevPageToken properties identify other pages that could be
   * retrieved.
   * @return LiveChatModeratorListResponse
   * @throws \Google\Service\Exception
   */
  public function listLiveChatModerators($liveChatId, $part, $optParams = [])
  {
    $params = ['liveChatId' => $liveChatId, 'part' => $part];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], LiveChatModeratorListResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LiveChatModerators::class, 'Google_Service_YouTube_Resource_LiveChatModerators');