Reference documentation and code samples for the Google Apps Chat V1 Client class CreateMembershipRequest.
Request message for creating a membership.
Generated from protobuf message google.chat.v1.CreateMembershipRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the space for which to create the membership. Format: spaces/{space} |
↳ membership |
Google\Apps\Chat\V1\Membership
Required. The membership relation to create. The |
↳ use_admin_access |
bool
When |
getParent
Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMembership
Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Chat\V1\Membership|null |
|
hasMembership
clearMembership
setMembership
Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Apps\Chat\V1\Membership
|
| 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.
Creating app memberships or creating memberships for users outside the
administrator's Google Workspace organization 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.
Creating app memberships or creating memberships for users outside the
administrator's Google Workspace organization isn't supported using admin
access.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the space for which to create the membership. Format: spaces/{space} Please see Google\Apps\Chat\V1\ChatServiceClient::spaceName() for help formatting this field. |
membership |
Google\Apps\Chat\V1\Membership
Required. The membership relation to create.
The |
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Chat\V1\CreateMembershipRequest |
|