Google Apps Chat V1 Client - Class DeleteMembershipRequest (0.6.1)

Version 0.6.1

• 0.7.0 (latest)
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.4

Reference documentation and code samples for the Google Apps Chat V1 Client class DeleteMembershipRequest.

Request to delete a membership in a space.

Generated from protobuf message google.chat.v1.DeleteMembershipRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user. When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format. Format: spaces/{space}/members/{member} or spaces/{space}/members/app.
↳ use_admin_access	bool 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. Deleting app memberships in a space isn't supported using admin access.

getName

Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user. When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format. Format: spaces/{space}/members/{member} or spaces/{space}/members/app.

Returns
Type	Description
string

setName

Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user. When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format. Format: spaces/{space}/members/{member} or spaces/{space}/members/app.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUseAdminAccess

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. Deleting app memberships in a space isn't supported using admin access.

Returns
Type	Description
bool

setUseAdminAccess

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. Deleting app memberships in a space isn't supported using admin access.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the chat.memberships scope and spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user. When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format. Format: spaces/{space}/members/{member} or spaces/{space}/members/app. Please see ChatServiceClient::membershipName() for help formatting this field.

Returns
Type	Description
DeleteMembershipRequest