Structures
| Structure | Description |
|---|---|
| PFGroupsAcceptGroupApplicationRequest | PFGroupsAcceptGroupApplicationRequest data model. Accepts an outstanding invitation to join a group if the invited entity is not blocked by the group. Nothing is returned in the case of success. |
| PFGroupsAcceptGroupInvitationRequest | PFGroupsAcceptGroupInvitationRequest data model. Accepts an outstanding invitation to join the group if the invited entity is not blocked by the group. Only the invited entity or a parent in its chain (e.g. title) may accept the invitation on the invited entity’s behalf. Nothing is returned in the case of success. |
| PFGroupsAddMembersRequest | PFGroupsAddMembersRequest data model. Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful. |
| PFGroupsApplyToGroupRequest | PFGroupsApplyToGroupRequest data model. Creates an application to join a group. Calling this while a group application already exists will return the same application instead of an error and will not refresh the time before the application expires. By default, if the entity has an invitation to join the group outstanding, this will accept the invitation to join the group instead and return an error indicating such, rather than creating a duplicate application to join that will need to be cleaned up later. Returns information about the application or an error indicating an invitation was accepted instead. |
| PFGroupsApplyToGroupResponse | PFGroupsApplyToGroupResponse data model. Describes an application to join a group. |
| PFGroupsBlockEntityRequest | PFGroupsBlockEntityRequest data model. Blocks a list of entities from joining a group. Blocked entities may not create new applications to join, be invited to join, accept an invitation, or have an application accepted. Failure due to being blocked does not clean up existing applications or invitations to the group. No data is returned in the case of success. |
| PFGroupsChangeMemberRoleRequest | PFGroupsChangeMemberRoleRequest data model. Changes the role membership of a list of entities from one role to another in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. Returns nothing if successful. |
| PFGroupsCreateGroupRequest | PFGroupsCreateGroupRequest data model. Creates a new group, as well as administration and member roles, based off of a title’s group template. Returns information about the group that was created. |
| PFGroupsCreateGroupResponse | PFGroupsCreateGroupResponse data model. |
| PFGroupsCreateGroupRoleRequest | PFGroupsCreateGroupRoleRequest data model. Creates a new role within an existing group, with no members. Both the role ID and role name must be unique within the group, but the name can be the same as the ID. The role ID is set at creation and cannot be changed. Returns information about the role that was created. |
| PFGroupsCreateGroupRoleResponse | PFGroupsCreateGroupRoleResponse data model. |
| PFGroupsDeleteGroupRequest | PFGroupsDeleteGroupRequest data model. Deletes a group and all roles, invitations, join requests, and blocks associated with it. Permission to delete is only required the group itself to execute this action. The group and data cannot be cannot be recovered once removed, but any abuse reports about the group will remain. No data is returned in the case of success. |
| PFGroupsDeleteRoleRequest | PFGroupsDeleteRoleRequest data model. Returns information about the role. |
| PFGroupsEntityMemberRole | PFGroupsEntityMemberRole data model. |
| PFGroupsEntityWithLineage | PFGroupsEntityWithLineage data model. Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity. |
| PFGroupsGetGroupRequest | PFGroupsGetGroupRequest data model. Returns the ID, name, role list and other non-membership related information about a group. |
| PFGroupsGetGroupResponse | PFGroupsGetGroupResponse data model. |
| PFGroupsGroupApplication | PFGroupsGroupApplication data model. Describes an application to join a group. |
| PFGroupsGroupBlock | PFGroupsGroupBlock data model. Describes an entity that is blocked from joining a group. |
| PFGroupsGroupInvitation | PFGroupsGroupInvitation data model. Describes an invitation to a group. |
| PFGroupsGroupRole | PFGroupsGroupRole data model. Describes a group role. |
| PFGroupsGroupWithRoles | PFGroupsGroupWithRoles data model. Describes a group and the roles that it contains. |
| PFGroupsInviteToGroupRequest | PFGroupsInviteToGroupRequest data model. Invites a player to join a group, if they are not blocked by the group. An optional role can be provided to automatically assign the player to the role if they accept the invitation. By default, if the entity has an application to the group outstanding, this will accept the application instead and return an error indicating such, rather than creating a duplicate invitation to join that will need to be cleaned up later. Returns information about the new invitation or an error indicating an existing application to join was accepted. |
| PFGroupsInviteToGroupResponse | PFGroupsInviteToGroupResponse data model. Describes an invitation to a group. |
| PFGroupsIsMemberRequest | PFGroupsIsMemberRequest data model. Checks to see if an entity is a member of a group or role within the group. A result indicating if the entity is a member of the group is returned, or a permission error if the caller does not have permission to read the group’s member list. |
| PFGroupsIsMemberResponse | PFGroupsIsMemberResponse data model. |
| PFGroupsListGroupApplicationsRequest | PFGroupsListGroupApplicationsRequest data model. Lists all outstanding requests to join a group. Returns a list of all requests to join, as well as when the request will expire. To get the group applications for a specific entity, use ListMembershipOpportunities. |
| PFGroupsListGroupApplicationsResponse | PFGroupsListGroupApplicationsResponse data model. |
| PFGroupsListGroupBlocksRequest | PFGroupsListGroupBlocksRequest data model. Lists all entities blocked from joining a group. A list of blocked entities is returned. |
| PFGroupsListGroupBlocksResponse | PFGroupsListGroupBlocksResponse data model. |
| PFGroupsListGroupInvitationsRequest | PFGroupsListGroupInvitationsRequest data model. Lists all outstanding invitations for a group. Returns a list of entities that have been invited, as well as when the invitation will expire. To get the group invitations for a specific entity, use ListMembershipOpportunities. |
| PFGroupsListGroupInvitationsResponse | PFGroupsListGroupInvitationsResponse data model. |
| PFGroupsListGroupMembersRequest | PFGroupsListGroupMembersRequest data model. Gets a list of members and the roles they belong to within the group. If the caller does not have permission to view the role, and the member is in no other role, the member is not displayed. Returns a list of entities that are members of the group. |
| PFGroupsListGroupMembersResponse | PFGroupsListGroupMembersResponse data model. |
| PFGroupsListMembershipOpportunitiesRequest | PFGroupsListMembershipOpportunitiesRequest data model. Lists all outstanding group applications and invitations for an entity. Anyone may call this for any entity, but data will only be returned for the entity or a parent of that entity. To list invitations or applications for a group to check if a player is trying to join, use ListGroupInvitations and ListGroupApplications. |
| PFGroupsListMembershipOpportunitiesResponse | PFGroupsListMembershipOpportunitiesResponse data model. |
| PFGroupsListMembershipRequest | PFGroupsListMembershipRequest data model. Lists the groups and roles that an entity is a part of, checking to see if group and role metadata and memberships should be visible to the caller. If the entity is not in any roles that are visible to the caller, the group is not returned in the results, even if the caller otherwise has permission to see that the entity is a member of that group. |
| PFGroupsListMembershipResponse | PFGroupsListMembershipResponse data model. |
| PFGroupsRemoveGroupApplicationRequest | PFGroupsRemoveGroupApplicationRequest data model. Removes an existing application to join the group. This is used for both rejection of an application as well as withdrawing an application. The applying entity or a parent in its chain (e.g. title) may withdraw the application, and any caller with appropriate access in the group may reject an application. No data is returned in the case of success. |
| PFGroupsRemoveGroupInvitationRequest | PFGroupsRemoveGroupInvitationRequest data model. Removes an existing invitation to join the group. This is used for both rejection of an invitation as well as rescinding an invitation. The invited entity or a parent in its chain (e.g. title) may reject the invitation by calling this method, and any caller with appropriate access in the group may rescind an invitation. No data is returned in the case of success. |
| PFGroupsRemoveMembersRequest | PFGroupsRemoveMembersRequest data model. Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful. |
| PFGroupsUnblockEntityRequest | PFGroupsUnblockEntityRequest data model. Unblocks a list of entities from joining a group. No data is returned in the case of success. |
| PFGroupsUpdateGroupRequest | PFGroupsUpdateGroupRequest data model. Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group. |
| PFGroupsUpdateGroupResponse | PFGroupsUpdateGroupResponse data model. |
| PFGroupsUpdateGroupRoleRequest | PFGroupsUpdateGroupRoleRequest data model. Updates the role name. Returns information about whether the update was successful. |
| PFGroupsUpdateGroupRoleResponse | PFGroupsUpdateGroupRoleResponse data model. |