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 \ V1Methods
__construct
Constructor.
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/example@gmail.com
where example@gmail.com
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
Optional. 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/example@gmail.com
where example@gmail.com
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
.
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/example@gmail.com
where example@gmail.com
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
.
var
string
$this
getUseAdminAccess
Optional. 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.
bool
setUseAdminAccess
Optional. 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.
var
bool
$this
static::build
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/example@gmail.com
where example@gmail.com
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.
