Services C API overview - PFGroupsTypes.h - XBOX Game Development Documentation

構造体

構造体	説明
PFGroupsAcceptGroupApplicationRequest	PFGroupsAcceptGroupApplicationRequest データモデル。招待されたエンティティがグループによってブロックされていない場合、グループへの参加の未処理の招待を承諾します。成功した場合、何も返されません。
PFGroupsAcceptGroupInvitationRequest	PFGroupsAcceptGroupInvitationRequest データモデル。招待されたエンティティがグループによってブロックされていない場合、グループへの参加の未処理の招待を承諾します。招待されたエンティティに代わって招待を承諾できるのは、招待されたエンティティ本人またはそのチェーン内の親 (タイトルなど) のみです。成功した場合、何も返されません。
PFGroupsAddMembersRequest	PFGroupsAddMembersRequest データモデル。グループまたはロールにメンバーを追加します。グループの既存メンバーはグループ内のロールに追加できますが、ユーザーがまだグループのメンバーでない場合は、タイトルクレーム所有者のみがグループに追加でき、それ以外の場合はグループ申請または招待システムを使用して新しいメンバーをグループに追加する必要があります。成功した場合、何も返されません。
PFGroupsApplyToGroupRequest	PFGroupsApplyToGroupRequest データモデル。グループへの参加申請を作成します。既にグループ申請が存在している状態でこれを呼び出すと、エラーではなく同じ申請が返され、申請の有効期限までの時間は更新されません。既定では、エンティティにグループへの参加の未処理の招待がある場合、これは代わりにグループへの参加の招待を承諾し、後でクリーンアップが必要になる重複した参加申請を作成する代わりに、その旨を示すエラーを返します。申請に関する情報、または代わりに招待が承諾されたことを示すエラーを返します。
PFGroupsApplyToGroupResponse	PFGroupsApplyToGroupResponse データモデル。グループへの参加申請を記述します。
PFGroupsBlockEntityRequest	PFGroupsBlockEntityRequest データモデル。エンティティの一覧がグループに参加できないようにブロックします。ブロックされたエンティティは、新しい参加申請の作成、参加への招待、招待の承諾、または申請の承諾を受けることができません。ブロックによる失敗では、グループへの既存の申請や招待はクリーンアップされません。成功した場合、データは返されません。
PFGroupsChangeMemberRoleRequest	PFGroupsChangeMemberRoleRequest データモデル。エンティティの一覧のロールメンバーシップを、単一の操作であるロールから別のロールに変更します。移動先のロールは既に存在している必要があります。これは、エンティティを移動先のロールに追加し、移動元のロールから削除することと同等です。成功した場合、何も返されません。
PFGroupsCreateGroupRequest	PFGroupsCreateGroupRequest データモデル。タイトルのグループテンプレートに基づいて、新しいグループと、管理者およびメンバーのロールを作成します。作成されたグループに関する情報を返します。
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 データモデル。グループへの既存の参加申請を削除します。これは申請の却下と申請の取り下げの両方で使用されます。申請を行ったエンティティまたはそのチェーン内の親 (タイトルなど) は申請を取り下げることができ、グループ内で適切なアクセス権を持つ呼び出し元は申請を却下できます。成功した場合、データは返されません。
PFGroupsRemoveGroupInvitationRequest	PFGroupsRemoveGroupInvitationRequest データモデル。グループへの既存の招待を削除します。これは招待の拒否と招待の取り消しの両方で使用されます。招待されたエンティティまたはそのチェーン内の親 (タイトルなど) は、このメソッドを呼び出して招待を拒否でき、グループ内で適切なアクセス権を持つ呼び出し元は招待を取り消せます。成功した場合、データは返されません。
PFGroupsRemoveMembersRequest	PFGroupsRemoveMembersRequest データモデル。グループからメンバーを削除します。メンバーは権限に関係なく、常にグループから自分自身を削除できます。成功した場合は何も返されません。
PFGroupsUnblockEntityRequest	PFGroupsUnblockEntityRequest データモデル。エンティティの一覧に対するグループ参加のブロックを解除します。成功した場合、データは返されません。
PFGroupsUpdateGroupRequest	PFGroupsUpdateGroupRequest データモデル。名前や既定のメンバーロールなど、グループに関するデータを更新します。更新が成功したかどうかに関する情報を返します。グループの管理者ロールを変更できるのはタイトルクレーム所有者のみです。
PFGroupsUpdateGroupResponse	PFGroupsUpdateGroupResponse データモデル。
PFGroupsUpdateGroupRoleRequest	PFGroupsUpdateGroupRoleRequest データモデル。ロール名を更新します。更新が成功したかどうかに関する情報を返します。
PFGroupsUpdateGroupRoleResponse	PFGroupsUpdateGroupRoleResponse データモデル。

​構造体

構造体