服务 C API 概览 - PFGroupsTypes.h - XBOX Game Development Documentation

结构

结构	说明
PFGroupsAcceptGroupApplicationRequest	PFGroupsAcceptGroupApplicationRequest 数据模型。如果被邀请的实体未被组阻止，则接受加入组的未处理邀请。成功时不返回任何数据。
PFGroupsAcceptGroupInvitationRequest	PFGroupsAcceptGroupInvitationRequest 数据模型。如果被邀请的实体未被组阻止，则接受加入组的未处理邀请。只有被邀请实体或其链中的父实体（例如 title）才能代表被邀请实体接受邀请。成功时不返回任何数据。
PFGroupsAddMembersRequest	PFGroupsAddMembersRequest 数据模型。向组或角色添加成员。组的现有成员将被添加到组内的角色，但如果用户尚未加入该组，则只有 title 声明者可以将其添加到组中，其他调用者必须使用组申请或邀请系统来向组中添加新成员。成功时不返回任何内容。
PFGroupsApplyToGroupRequest	PFGroupsApplyToGroupRequest 数据模型。创建加入组的申请。当组申请已存在时调用此方法将返回相同的申请而不是错误，且不会刷新申请到期前的时间。默认情况下，如果该实体已有加入该组的未处理邀请，此调用将改为接受该邀请并返回相应的错误，而不是创建以后需要清理的重复加入申请。返回有关申请的信息，或指示已接受邀请的错误。
PFGroupsApplyToGroupResponse	PFGroupsApplyToGroupResponse 数据模型。描述加入组的申请。
PFGroupsBlockEntityRequest	PFGroupsBlockEntityRequest 数据模型。阻止一组实体加入组。被阻止的实体无法创建新的加入申请、被邀请加入、接受邀请或被接受申请。因被阻止而失败不会清除对该组的现有申请或邀请。成功时不返回任何数据。
PFGroupsChangeMemberRoleRequest	PFGroupsChangeMemberRoleRequest 数据模型。在单个操作中将一组实体的角色成员关系从一个角色更改为另一个角色。目标角色必须已存在。这相当于将实体添加到目标角色并从原角色中移除。成功时不返回任何内容。
PFGroupsCreateGroupRequest	PFGroupsCreateGroupRequest 数据模型。基于 title 的组模板创建新组，以及管理员和成员角色。返回有关所创建组的信息。
PFGroupsCreateGroupResponse	PFGroupsCreateGroupResponse 数据模型。
PFGroupsCreateGroupRoleRequest	PFGroupsCreateGroupRoleRequest 数据模型。在现有组中创建一个不包含成员的新角色。角色 ID 和角色名称在组内必须是唯一的，但名称可以与 ID 相同。角色 ID 在创建时设置，不可更改。返回有关所创建角色的信息。
PFGroupsCreateGroupRoleResponse	PFGroupsCreateGroupRoleResponse 数据模型。
PFGroupsDeleteGroupRequest	PFGroupsDeleteGroupRequest 数据模型。删除组以及与其关联的所有角色、邀请、加入请求和阻止项。执行此操作只需要对组本身具有删除权限。删除后无法恢复组和数据，但对该组的任何滥用报告都将保留。成功时不返回任何数据。
PFGroupsDeleteRoleRequest	PFGroupsDeleteRoleRequest 数据模型。返回有关角色的信息。
PFGroupsEntityMemberRole	PFGroupsEntityMemberRole 数据模型。
PFGroupsEntityWithLineage	PFGroupsEntityWithLineage 数据模型。实体包装类，其中包含实体键以及构成该实体谱系的实体。
PFGroupsGetGroupRequest	PFGroupsGetGroupRequest 数据模型。返回组的 ID、名称、角色列表及其他非成员关系相关信息。
PFGroupsGetGroupResponse	PFGroupsGetGroupResponse 数据模型。
PFGroupsGroupApplication	PFGroupsGroupApplication 数据模型。描述加入组的申请。
PFGroupsGroupBlock	PFGroupsGroupBlock 数据模型。描述被阻止加入组的实体。
PFGroupsGroupInvitation	PFGroupsGroupInvitation 数据模型。描述对组的邀请。
PFGroupsGroupRole	PFGroupsGroupRole 数据模型。描述组角色。
PFGroupsGroupWithRoles	PFGroupsGroupWithRoles 数据模型。描述组及其包含的角色。
PFGroupsInviteToGroupRequest	PFGroupsInviteToGroupRequest 数据模型。如果玩家未被组阻止，则邀请其加入组。可以提供一个可选角色，以便玩家接受邀请后自动分配到该角色。默认情况下，如果实体已有对该组的未处理申请，此调用将改为接受该申请并返回相应的错误，而不是创建以后需要清理的重复加入邀请。返回有关新邀请的信息，或指示已接受现有加入申请的错误。
PFGroupsInviteToGroupResponse	PFGroupsInviteToGroupResponse 数据模型。描述对组的邀请。
PFGroupsIsMemberRequest	PFGroupsIsMemberRequest 数据模型。检查实体是否为组的成员或组内某个角色的成员。将返回指示该实体是否为组成员的结果；如果调用方无权读取组的成员列表，则返回权限错误。
PFGroupsIsMemberResponse	PFGroupsIsMemberResponse 数据模型。
PFGroupsListGroupApplicationsRequest	PFGroupsListGroupApplicationsRequest 数据模型。列出加入组的所有未处理请求。返回所有加入请求的列表以及请求过期的时间。要获取特定实体的组申请，请使用 ListMembershipOpportunities。
PFGroupsListGroupApplicationsResponse	PFGroupsListGroupApplicationsResponse 数据模型。
PFGroupsListGroupBlocksRequest	PFGroupsListGroupBlocksRequest 数据模型。列出所有被阻止加入组的实体。返回被阻止实体的列表。
PFGroupsListGroupBlocksResponse	PFGroupsListGroupBlocksResponse 数据模型。
PFGroupsListGroupInvitationsRequest	PFGroupsListGroupInvitationsRequest 数据模型。列出组的所有未处理邀请。返回已被邀请的实体列表以及邀请的过期时间。要获取特定实体的组邀请，请使用 ListMembershipOpportunities。
PFGroupsListGroupInvitationsResponse	PFGroupsListGroupInvitationsResponse 数据模型。
PFGroupsListGroupMembersRequest	PFGroupsListGroupMembersRequest 数据模型。获取组内成员及其所属角色的列表。如果调用方无权查看某个角色，且该成员不属于任何其他角色，则不会显示该成员。返回该组成员实体的列表。
PFGroupsListGroupMembersResponse	PFGroupsListGroupMembersResponse 数据模型。
PFGroupsListMembershipOpportunitiesRequest	PFGroupsListMembershipOpportunitiesRequest 数据模型。列出实体的所有未处理组申请和邀请。任何人都可以为任意实体调用此 API，但只会返回该实体或其父实体的数据。要列出某个组的邀请或申请以检查是否有玩家尝试加入，请使用 ListGroupInvitations 和 ListGroupApplications。
PFGroupsListMembershipOpportunitiesResponse	PFGroupsListMembershipOpportunitiesResponse 数据模型。
PFGroupsListMembershipRequest	PFGroupsListMembershipRequest 数据模型。列出实体所属的组和角色，并检查组、角色元数据以及成员关系是否对调用方可见。如果该实体不在任何对调用方可见的角色中，则即使调用方原本有权查看该实体是该组成员，此组也不会出现在结果中。
PFGroupsListMembershipResponse	PFGroupsListMembershipResponse 数据模型。
PFGroupsRemoveGroupApplicationRequest	PFGroupsRemoveGroupApplicationRequest 数据模型。移除现有的加入组申请。此操作用于拒绝申请以及撤回申请。申请实体或其链中的父实体（例如 title）可以撤回申请，任何在组中具有相应访问权限的调用方均可拒绝申请。成功时不返回任何数据。
PFGroupsRemoveGroupInvitationRequest	PFGroupsRemoveGroupInvitationRequest 数据模型。移除现有的加入组邀请。此操作用于拒绝邀请以及撤销邀请。被邀请实体或其链中的父实体（例如 title）可通过调用此方法来拒绝邀请，任何在组中具有相应访问权限的调用方均可撤销邀请。成功时不返回任何数据。
PFGroupsRemoveMembersRequest	PFGroupsRemoveMembersRequest 数据模型。从组中移除成员。无论权限如何，成员始终可以将自己从组中移除。成功时不返回任何内容。
PFGroupsUnblockEntityRequest	PFGroupsUnblockEntityRequest 数据模型。解除对一组实体加入组的阻止。成功时不返回任何数据。
PFGroupsUpdateGroupRequest	PFGroupsUpdateGroupRequest 数据模型。更新组的数据，例如名称或默认成员角色。返回有关更新是否成功的信息。只有 title 声明者可以修改组的管理员角色。
PFGroupsUpdateGroupResponse	PFGroupsUpdateGroupResponse 数据模型。
PFGroupsUpdateGroupRoleRequest	PFGroupsUpdateGroupRoleRequest 数据模型。更新角色名称。返回有关更新是否成功的信息。
PFGroupsUpdateGroupRoleResponse	PFGroupsUpdateGroupRoleResponse 数据模型。

​结构

结构