PlayFab.GroupsModels Namespace Reference

Classes
class	AcceptGroupApplicationRequest
	Accepts an outstanding invitation to to join a group if the invited entity is not blocked by the group. Nothing is returned in the case of success. More...
class	AcceptGroupInvitationRequest
	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. More...
class	AddMembersRequest
	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. More...
class	ApplyToGroupRequest
	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. More...
class	ApplyToGroupResponse
	Describes an application to join a group. More...
class	BlockEntityRequest
	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. More...
class	ChangeMemberRoleRequest
	Changes the role membership of a list of entities from one role to another in 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. More...
class	CreateGroupRequest
	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. More...
class	CreateGroupResponse
class	CreateGroupRoleRequest
	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. More...
class	CreateGroupRoleResponse
class	DeleteGroupRequest
	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. More...
class	DeleteRoleRequest
	Returns information about the role. More...
class	EmptyResponse
class	EntityKey
	Combined entity type and ID structure which uniquely identifies a single entity. More...
class	EntityMemberRole
class	EntityWithLineage
	Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity. More...
class	GetGroupRequest
	Returns the ID, name, role list and other non-membership related information about a group. More...
class	GetGroupResponse
class	GroupApplication
	Describes an application to join a group. More...
class	GroupBlock
	Describes an entity that is blocked from joining a group. More...
class	GroupInvitation
	Describes an invitation to a group. More...
class	GroupRole
	Describes a group role. More...
class	GroupWithRoles
	Describes a group and the roles that it contains. More...
class	InviteToGroupRequest
	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. More...
class	InviteToGroupResponse
	Describes an invitation to a group. More...
class	IsMemberRequest
	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. More...
class	IsMemberResponse
class	ListGroupApplicationsRequest
	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. More...
class	ListGroupApplicationsResponse
class	ListGroupBlocksRequest
	Lists all entities blocked from joining a group. A list of blocked entities is returned. More...
class	ListGroupBlocksResponse
class	ListGroupInvitationsRequest
	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. More...
class	ListGroupInvitationsResponse
class	ListGroupMembersRequest
	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. More...
class	ListGroupMembersResponse
class	ListMembershipOpportunitiesRequest
	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. More...
class	ListMembershipOpportunitiesResponse
class	ListMembershipRequest
	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. More...
class	ListMembershipResponse
class	RemoveGroupApplicationRequest
	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. More...
class	RemoveGroupInvitationRequest
	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. More...
class	RemoveMembersRequest
	Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful. More...
class	UnblockEntityRequest
	Unblocks a list of entities from joining a group. No data is returned in the case of success. More...
class	UpdateGroupRequest
	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. More...
class	UpdateGroupResponse
class	UpdateGroupRoleRequest
	Updates the role name. Returns information about whether the update was successful. More...
class	UpdateGroupRoleResponse

Enumerations
enum	OperationTypes { Created , Updated , Deleted , None }