REST Resource: spaces.members

资源:成员资格

表示 Google Chat 中的成员资格关系,例如用户或 Chat 应用是受邀加入聊天室、是聊天室的一部分,还是不在聊天室中。

JSON 表示法
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,

  // Union field memberType can be only one of the following:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
  // End of list of possible types for union field memberType.
}
字段
name

string

成员的资源名称,由服务器分配。

格式:spaces/{space}/members/{member}

state

enum (MembershipState)

仅供输出。成员的状态。

role

enum (MembershipRole)

可选。用户在 Chat 聊天室中的角色,决定了该用户在聊天室中可以执行的操作。

此字段只能在 members.patch 中用作输入。

createTime

string (Timestamp format)

仅供输出。成员资格的创建时间,例如成员加入或受邀加入聊天室的时间。

联合字段 memberType。与此会员资格相关联的会员。未来可能会支持其他成员类型。memberType 只能是下列其中一项:
member

object (User)

与会员身份对应的 Google Chat 用户或应用。如果您的 Chat 应用以用户身份进行身份验证,输出内容会填充用户 nametype

groupMember

object (Group)

成员资格对应的 Google 群组。仅支持读取操作。目前不支持其他操作,如创建或更新成员资格。

MembershipState

指定成员与聊天室的关系。未来可能会支持其他成员资格状态。

枚举
MEMBERSHIP_STATE_UNSPECIFIED 默认值。请勿使用。
JOINED 系统会将用户添加到聊天室,并可以加入聊天室。
INVITED 用户受邀加入聊天室,但尚未加入。
NOT_A_MEMBER 此用户不是聊天室的成员,也没有受邀加入聊天室的待处理邀请。

MembershipRole

表示用户在 Chat 聊天室中允许执行的操作。未来我们可能会添加更多枚举值。

枚举
MEMBERSHIP_ROLE_UNSPECIFIED 默认值。对于users:他们不是聊天室成员,但可以受邀。对于 Google Groups:系统始终会为其分配此角色(将来可能会使用其他枚举值)。
ROLE_MEMBER 聊天室的成员。用户拥有基本权限,例如向聊天室发送消息。在 1 对 1 群组对话和未命名的群组对话中,每个人都拥有此角色。
ROLE_MANAGER 聊天室管理员。用户拥有所有基本权限以及允许其管理聊天室(例如添加或移除成员)的管理权限。仅在 SpaceType.SPACE 中受支持。

群组

Google Chat 中的 Google 群组。

JSON 表示法
{
  "name": string
}
字段
name

string

Google 群组的资源名称。

表示 Cloud Identity Groups API 中的群组。

格式:groups/{group}

方法

create

为发起调用的应用创建人类成员资格或应用成员资格。

delete

删除会员资格。

get

返回有关会员资格的详细信息。

list

列出聊天室中的成员。

patch

更新会员资格。