[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 |
|
---|
| 18 | namespace Google\Service\HangoutsChat\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\HangoutsChat\ThreadReadState;
|
---|
| 21 |
|
---|
| 22 | /**
|
---|
| 23 | * The "threads" collection of methods.
|
---|
| 24 | * Typical usage is:
|
---|
| 25 | * <code>
|
---|
| 26 | * $chatService = new Google\Service\HangoutsChat(...);
|
---|
| 27 | * $threads = $chatService->users_spaces_threads;
|
---|
| 28 | * </code>
|
---|
| 29 | */
|
---|
| 30 | class UsersSpacesThreads extends \Google\Service\Resource
|
---|
| 31 | {
|
---|
| 32 | /**
|
---|
| 33 | * Returns details about a user's read state within a thread, used to identify
|
---|
| 34 | * read and unread messages. For an example, see [Get details about a user's
|
---|
| 35 | * thread read state](https://developers.google.com/workspace/chat/get-thread-
|
---|
| 36 | * read-state). Requires [user
|
---|
| 37 | * authentication](https://developers.google.com/workspace/chat/authenticate-
|
---|
| 38 | * authorize-chat-user). (threads.getThreadReadState)
|
---|
| 39 | *
|
---|
| 40 | * @param string $name Required. Resource name of the thread read state to
|
---|
| 41 | * retrieve. Only supports getting read state for the calling user. To refer to
|
---|
| 42 | * the calling user, set one of the following: - The `me` alias. For example,
|
---|
| 43 | * `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace
|
---|
| 44 | * email address. For example,
|
---|
| 45 | * `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. -
|
---|
| 46 | * Their user id. For example,
|
---|
| 47 | * `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format:
|
---|
| 48 | * users/{user}/spaces/{space}/threads/{thread}/threadReadState
|
---|
| 49 | * @param array $optParams Optional parameters.
|
---|
| 50 | * @return ThreadReadState
|
---|
| 51 | * @throws \Google\Service\Exception
|
---|
| 52 | */
|
---|
| 53 | public function getThreadReadState($name, $optParams = [])
|
---|
| 54 | {
|
---|
| 55 | $params = ['name' => $name];
|
---|
| 56 | $params = array_merge($params, $optParams);
|
---|
| 57 | return $this->call('getThreadReadState', [$params], ThreadReadState::class);
|
---|
| 58 | }
|
---|
| 59 | }
|
---|
| 60 |
|
---|
| 61 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 62 | class_alias(UsersSpacesThreads::class, 'Google_Service_HangoutsChat_Resource_UsersSpacesThreads');
|
---|