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.
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 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
.
getParent
Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string
setParent
Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
var
string
$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
.
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
.
$this
static::build
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 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
.
