Viewing file:  SpacesMembers.php (4.04 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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\HangoutsChat\Resource;
use Google\Service\HangoutsChat\ListMembershipsResponse;
use Google\Service\HangoutsChat\Membership;
/**
* The "members" collection of methods.
* Typical usage is:
* <code>
* $chatService = new Google\Service\HangoutsChat(...);
* $members = $chatService->spaces_members;
* </code>
*/
class SpacesMembers extends \Google\Service\Resource
{
/**
* Returns a membership. Requires
* [authentication](https://developers.google.com/chat/api/guides/auth/). Fully
* supports [service account
* authentication](https://developers.google.com/chat/api/guides/auth/service-
* accounts). Supports [user
* authentication](https://developers.google.com/chat/api/guides/auth/users) as
* part of the [Google Workspace Developer Preview
* Program](https://developers.google.com/workspace/preview), which grants early
* access to certain features. [User
* authentication](https://developers.google.com/chat/api/guides/auth/users)
* requires the `chat.memberships` or `chat.memberships.readonly` authorization
* scope. (members.get)
*
* @param string $name Required. Resource name of the membership to retrieve.
* Format: spaces/{space}/members/{member}
* @param array $optParams Optional parameters.
* @return Membership
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Membership::class);
}
/**
* Lists memberships in a space. Requires
* [authentication](https://developers.google.com/chat/api/guides/auth/). Fully
* supports [service account
* authentication](https://developers.google.com/chat/api/guides/auth/service-
* accounts). Supports [user
* authentication](https://developers.google.com/chat/api/guides/auth/users) as
* part of the [Google Workspace Developer Preview
* Program](https://developers.google.com/workspace/preview), which grants early
* access to certain features. [User
* authentication](https://developers.google.com/chat/api/guides/auth/users)
* requires the `chat.memberships` or `chat.memberships.readonly` authorization
* scope. (members.listSpacesMembers)
*
* @param string $parent Required. The resource name of the space for which to
* fetch a membership list. Format: spaces/{space}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of memberships to return. The
* service may return fewer than this value. If unspecified, at most 100
* memberships are returned. The maximum value is 1000; values above 1000 are
* coerced to 1000. Negative values return an INVALID_ARGUMENT error.
* @opt_param string pageToken A page token, received from a previous list
* memberships call. Provide this to retrieve the subsequent page. When
* paginating, all other parameters provided should match the call that provided
* the page token. Passing different values to the other parameters may lead to
* unexpected results.
* @return ListMembershipsResponse
*/
public function listSpacesMembers($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListMembershipsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SpacesMembers::class, 'Google_Service_HangoutsChat_Resource_SpacesMembers');
|