public interface CreateMembershipRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getMembership()
public abstract Membership 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.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Membership |
The membership. |
getMembershipOrBuilder()
public abstract MembershipOrBuilder getMembershipOrBuilder() 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.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MembershipOrBuilder |
|
getParent()
public abstract String getParent()Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getUseAdminAccess()
public abstract boolean 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.
bool use_admin_access = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The useAdminAccess. |
hasMembership()
public abstract boolean hasMembership() 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.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the membership field is set. |