服務 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 資料模型。在現有群組內建立沒有成員的新角色。角色識別碼和角色名稱在群組內都必須是唯一的，但名稱可以與識別碼相同。角色識別碼會在建立時設定，且無法變更。傳回所建立角色的相關資訊。
PFGroupsCreateGroupRoleResponse	PFGroupsCreateGroupRoleResponse 資料模型。
PFGroupsDeleteGroupRequest	PFGroupsDeleteGroupRequest 資料模型。刪除群組以及與其相關聯的所有角色、邀請、加入要求和封鎖。只需要群組本身的刪除權限即可執行此動作。群組和資料一經移除便無法復原，但有關該群組的任何濫用檢舉都會保留。成功時不會傳回任何資料。
PFGroupsDeleteRoleRequest	PFGroupsDeleteRoleRequest 資料模型。傳回角色的相關資訊。
PFGroupsEntityMemberRole	PFGroupsEntityMemberRole 資料模型。
PFGroupsEntityWithLineage	PFGroupsEntityWithLineage 資料模型。包含實體索引鍵以及構成該實體譜系之實體的實體包裝函式類別。
PFGroupsGetGroupRequest	PFGroupsGetGroupRequest 資料模型。傳回群組的識別碼、名稱、角色清單和其他非成員資格相關資訊。
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 資料模型。列出實體所有未處理的群組申請和邀請。任何人都可以針對任何實體呼叫此方法，但只會為該實體或該實體的上層實體傳回資料。若要列出群組的邀請或申請以檢查玩家是否正嘗試加入，請使用 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 資料模型。

PlayFab API

PlayFab REST API References

服務 C API 概觀 - PFGroupsTypes.h

結構

​結構

結構