Google Apps Chat V1 Client - Class UpdateMembershipRequest (0.10.0)

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

Request message for updating a membership.

Generated from protobuf message google.chat.v1.UpdateMembershipRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ membership
Membership

Required. The membership to update. Only fields specified by update_mask are updated.

↳ update_mask
Google\Protobuf\FieldMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths. Currently supported field paths: - role

↳ 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 .

getMembership

Required. The membership to update. Only fields specified by update_mask are updated.

Returns
Type
Description
Membership |null

hasMembership

clearMembership

setMembership

Required. The membership to update. Only fields specified by update_mask are updated.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

  • role
Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

  • role
Parameter
Name
Description
Returns
Type
Description
$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 .

Returns
Type
Description
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 .

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameters
Name
Description
membership
Membership

Required. The membership to update. Only fields specified by update_mask are updated.

updateMask
Google\Protobuf\FieldMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

  • role
Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: