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 \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ membership |
Google\Apps\Chat\V1\Membership
Required. The membership to update. Only fields specified by |
↳ update_mask |
Google\Protobuf\FieldMask
Required. The field paths to update. Separate multiple values with commas or use |
↳ use_admin_access |
bool
When |
getMembership
Required. The membership to update. Only fields specified by update_mask
are updated.
Returns | |
---|---|
Type | Description |
Google\Apps\Chat\V1\Membership|null |
hasMembership
clearMembership
setMembership
Required. The membership to update. Only fields specified by update_mask
are updated.
Parameter | |
---|---|
Name | Description |
var |
Google\Apps\Chat\V1\Membership
|
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 |
Google\Protobuf\FieldMask|null |
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 |
var |
Google\Protobuf\FieldMask
|
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.
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
membership |
Google\Apps\Chat\V1\Membership
Required. The membership to update. Only fields specified by |
updateMask |
Google\Protobuf\FieldMask
Required. The field paths to update. Separate multiple values with commas
or use Currently supported field paths:
|
Returns | |
---|---|
Type | Description |
Google\Apps\Chat\V1\UpdateMembershipRequest |