Reference documentation and code samples for the Google Apps Chat V1 Client class GetMembershipRequest.
Request to get a membership of a space.
Generated from protobuf message google.chat.v1.GetMembershipRequest
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 retrieve. To get the app's own membership by using user authentication
, you can optionally use spaces/{space}/members/app
. Format: spaces/{space}/members/{member}
or spaces/{space}/members/app
When authenticated as a user
, you can use the user's 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.
↳ 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
or chat.admin.memberships.readonly
OAuth 2.0 scopes
. Getting app memberships in a space isn't supported when using admin access.
getName
Required. Resource name of the membership to retrieve.
To get the app's own membership by using user
authentication
,
you can optionally use spaces/{space}/members/app
.
Format: spaces/{space}/members/{member}
or spaces/{space}/members/app
When authenticated as a
user
,
you can use the user's 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.
string
setName
Required. Resource name of the membership to retrieve.
To get the app's own membership by using user
authentication
,
you can optionally use spaces/{space}/members/app
.
Format: spaces/{space}/members/{member}
or spaces/{space}/members/app
When authenticated as a
user
,
you can use the user's 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.
var
string
$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
or chat.admin.memberships.readonly
OAuth 2.0
scopes
.
Getting app memberships in a space isn't supported when using admin access.
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
or chat.admin.memberships.readonly
OAuth 2.0
scopes
.
Getting app memberships in a space isn't supported when using admin access.
var
bool
$this
static::build
name
string
Required. Resource name of the membership to retrieve.
To get the app's own membership by using user
authentication
,
you can optionally use spaces/{space}/members/app
.
Format: spaces/{space}/members/{member}
or spaces/{space}/members/app
When authenticated as a
user
,
you can use the user's 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. Please see ChatServiceClient::membershipName()
for help formatting this field.
