Google Chat V1 API - Class Google::Apps::Chat::V1::GetMembershipRequest (v0.5.1)

Version 0.5.1

• 0.7.0 (latest)
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.2

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::GetMembershipRequest.

Request to get a membership of a space.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String

Returns

• (::String) — Required. Resource name of the membership to retrieve.

  To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

  Format: spaces/{space}/members/{member} or spaces/{space}/members/app

  When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Required. Resource name of the membership to retrieve.

  To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

  Format: spaces/{space}/members/{member} or spaces/{space}/members/app

  When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user.

Returns

• (::String) — Required. Resource name of the membership to retrieve.

  To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

  Format: spaces/{space}/members/{member} or spaces/{space}/members/app

  When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user.

#use_admin_access

def use_admin_access() -> ::Boolean

Returns

• (::Boolean) — When true, the method runs using the user's Google Workspace administrator privileges.

  The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

  Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes.

  Getting app memberships in a space isn't supported when using admin access.

#use_admin_access=

def use_admin_access=(value) -> ::Boolean

Parameter

• value (::Boolean) — When true, the method runs using the user's Google Workspace administrator privileges.

  The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

  Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes.

  Getting app memberships in a space isn't supported when using admin access.

Returns

• (::Boolean) — When true, the method runs using the user's Google Workspace administrator privileges.

  The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

  Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes.

  Getting app memberships in a space isn't supported when using admin access.