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 certain authorization scopes and set specific values for certain fields:
- When authenticating as a user, the - chat.membershipsauthorization scope is required.
- When authenticating as an app, the - chat.app.membershipsauthorization scope is required. Authenticating as an app is available in Developer Preview.
- Set - user.typeto- HUMAN, and set- user.namewith 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- idof the person from the People API, or the- idfor the user in the Directory API. For example, if the People API Person profile ID for- user@example.comis- 123456789, you can add the user to the space by setting the- membership.member.nameto- users/user@example.comor- users/123456789.- Inviting users external to the Workspace organization that owns the space requires user authentication. - When a Chat app creates a membership relation for itself, it must authenticate as a user and use the - chat.memberships.appscope, set- user.typeto- BOT, and set- user.nameto- 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 certain authorization scopes and set specific values for certain fields:
- When authenticating as a user, the - chat.membershipsauthorization scope is required.
- When authenticating as an app, the - chat.app.membershipsauthorization scope is required. Authenticating as an app is available in Developer Preview.
- Set - user.typeto- HUMAN, and set- user.namewith 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- idof the person from the People API, or the- idfor the user in the Directory API. For example, if the People API Person profile ID for- user@example.comis- 123456789, you can add the user to the space by setting the- membership.member.nameto- users/user@example.comor- users/123456789.- Inviting users external to the Workspace organization that owns the space requires user authentication. - When a Chat app creates a membership relation for itself, it must authenticate as a user and use the - chat.memberships.appscope, set- user.typeto- BOT, and set- user.nameto- 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() Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 certain authorization scopes and set specific values for certain fields:
- When authenticating as a user, the - chat.membershipsauthorization scope is required.
- When authenticating as an app, the - chat.app.membershipsauthorization scope is required. Authenticating as an app is available in Developer Preview.
- Set - user.typeto- HUMAN, and set- user.namewith 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- idof the person from the People API, or the- idfor the user in the Directory API. For example, if the People API Person profile ID for- user@example.comis- 123456789, you can add the user to the space by setting the- membership.member.nameto- users/user@example.comor- users/123456789.- Inviting users external to the Workspace organization that owns the space requires user authentication. - When a Chat app creates a membership relation for itself, it must authenticate as a user and use the - chat.memberships.appscope, set- user.typeto- BOT, and set- user.nameto- users/app.
 .google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
| boolean | Whether the membership field is set. |