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

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

Request message for creating a membership.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#membership

def membership() -> ::Google::Apps::Chat::V1::Membership
Returns
  • (::Google::Apps::Chat::V1::Membership) — Required. The membership relation to create. The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified. When a Chat app creates a membership relation for a human user, it must use the chat.memberships scope, set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. When a Chat app creates a membership relation for itself, it must use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

#membership=

def membership=(value) -> ::Google::Apps::Chat::V1::Membership
Parameter
  • value (::Google::Apps::Chat::V1::Membership) — Required. The membership relation to create. The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified. When a Chat app creates a membership relation for a human user, it must use the chat.memberships scope, set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. When a Chat app creates a membership relation for itself, it must use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.
Returns
  • (::Google::Apps::Chat::V1::Membership) — Required. The membership relation to create. The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified. When a Chat app creates a membership relation for a human user, it must use the chat.memberships scope, set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. When a Chat app creates a membership relation for itself, it must use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the space for which to create the membership.

    Format: spaces/{space}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the space for which to create the membership.

    Format: spaces/{space}

Returns
  • (::String) — Required. The resource name of the space for which to create the membership.

    Format: spaces/{space}

#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 OAuth 2.0 scope.

    Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported 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 OAuth 2.0 scope.

    Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported 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 OAuth 2.0 scope.

    Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.