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

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

Upload project files

  • Property mode set to 100644
File size: 4.3 KB
RevLine 
[e3d4e0a]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\LiveChatMessage;
21use Google\Service\YouTube\LiveChatMessageListResponse;
22
23/**
24 * The "liveChatMessages" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $youtubeService = new Google\Service\YouTube(...);
28 * $liveChatMessages = $youtubeService->liveChatMessages;
29 * </code>
30 */
31class LiveChatMessages extends \Google\Service\Resource
32{
33 /**
34 * Deletes a chat message. (liveChatMessages.delete)
35 *
36 * @param string $id
37 * @param array $optParams Optional parameters.
38 * @throws \Google\Service\Exception
39 */
40 public function delete($id, $optParams = [])
41 {
42 $params = ['id' => $id];
43 $params = array_merge($params, $optParams);
44 return $this->call('delete', [$params]);
45 }
46 /**
47 * Inserts a new resource into this collection. (liveChatMessages.insert)
48 *
49 * @param string|array $part The *part* parameter serves two purposes. It
50 * identifies the properties that the write operation will set as well as the
51 * properties that the API response will include. Set the parameter value to
52 * snippet.
53 * @param LiveChatMessage $postBody
54 * @param array $optParams Optional parameters.
55 * @return LiveChatMessage
56 * @throws \Google\Service\Exception
57 */
58 public function insert($part, LiveChatMessage $postBody, $optParams = [])
59 {
60 $params = ['part' => $part, 'postBody' => $postBody];
61 $params = array_merge($params, $optParams);
62 return $this->call('insert', [$params], LiveChatMessage::class);
63 }
64 /**
65 * Retrieves a list of resources, possibly filtered.
66 * (liveChatMessages.listLiveChatMessages)
67 *
68 * @param string $liveChatId The id of the live chat for which comments should
69 * be returned.
70 * @param string|array $part The *part* parameter specifies the liveChatComment
71 * resource parts that the API response will include. Supported values are id,
72 * snippet, and authorDetails.
73 * @param array $optParams Optional parameters.
74 *
75 * @opt_param string hl Specifies the localization language in which the system
76 * messages should be returned.
77 * @opt_param string maxResults The *maxResults* parameter specifies the maximum
78 * number of items that should be returned in the result set. Not used in the
79 * streaming RPC.
80 * @opt_param string pageToken The *pageToken* parameter identifies a specific
81 * page in the result set that should be returned. In an API response, the
82 * nextPageToken property identify other pages that could be retrieved.
83 * @opt_param string profileImageSize Specifies the size of the profile image
84 * that should be returned for each user.
85 * @return LiveChatMessageListResponse
86 * @throws \Google\Service\Exception
87 */
88 public function listLiveChatMessages($liveChatId, $part, $optParams = [])
89 {
90 $params = ['liveChatId' => $liveChatId, 'part' => $part];
91 $params = array_merge($params, $optParams);
92 return $this->call('list', [$params], LiveChatMessageListResponse::class);
93 }
94 /**
95 * Transition a durable chat event. (liveChatMessages.transition)
96 *
97 * @param array $optParams Optional parameters.
98 *
99 * @opt_param string id The ID that uniquely identify the chat message event to
100 * transition.
101 * @opt_param string status The status to which the chat event is going to
102 * transition.
103 * @return LiveChatMessage
104 * @throws \Google\Service\Exception
105 */
106 public function transition($optParams = [])
107 {
108 $params = [];
109 $params = array_merge($params, $optParams);
110 return $this->call('transition', [$params], LiveChatMessage::class);
111 }
112}
113
114// Adding a class alias for backwards compatibility with the previous class name.
115class_alias(LiveChatMessages::class, 'Google_Service_YouTube_Resource_LiveChatMessages');
Note: See TracBrowser for help on using the repository browser.