Class SpacesResource.FindGroupChatsRequest

Developer Preview: Returns all spaces with spaceType == GROUP_CHAT, whose human memberships contain exactly the calling user, and the users specified in FindGroupChatsRequest.users. Only members that have joined the conversation are supported. For an example, see Find group chats. If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.memberships.readonly - https://www.googleapis.com/auth/chat.memberships

Inheritance
object
ClientServiceRequest
ClientServiceRequest<FindGroupChatsResponse>
HangoutsChatBaseServiceRequest<FindGroupChatsResponse>
SpacesResource.FindGroupChatsRequest
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class SpacesResource.FindGroupChatsRequest : HangoutsChatBaseServiceRequest<FindGroupChatsResponse>, IClientServiceRequest<FindGroupChatsResponse>, IClientServiceRequest

Constructors

FindGroupChatsRequest(IClientService)

Constructs a new FindGroupChats request.

Declaration
public FindGroupChatsRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an INVALID_ARGUMENT error.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SpaceView

Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

Declaration
[RequestParameter("spaceView", RequestParameterType.Query)]
public virtual SpacesResource.FindGroupChatsRequest.SpaceViewEnum? SpaceView { get; set; }
Property Value
Type Description
SpacesResource.FindGroupChatsRequest.SpaceViewEnum?

Users

Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is 49. Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

Declaration
[RequestParameter("users", RequestParameterType.Query)]
public virtual Repeatable<string> Users { get; set; }
Property Value
Type Description
Repeatable<string>

Methods

InitParameters()

Initializes FindGroupChats parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements