PlayFab.PlayFabGroupsInstanceAPI Class Reference

The Groups API is designed for any permanent or semi-permanent collections of Entities (players, or non-players). If you want to make Guilds/Clans/Corporations/etc., then you should use groups. Groups can also be used to make chatrooms, parties, or any other persistent collection of entities. More...

Inheritance diagram for PlayFab.PlayFabGroupsInstanceAPI:

Public Member Functions
	PlayFabGroupsInstanceAPI (PlayFabAuthenticationContext context)
	PlayFabGroupsInstanceAPI (PlayFabApiSettings settings, PlayFabAuthenticationContext context)
bool	IsEntityLoggedIn ()
	Verify entity login.
void	ForgetAllCredentials ()
	Clear the Client SessionToken which allows this Client to call API calls requiring login. A new/fresh login will be required after calling this.
void	AcceptGroupApplication (AcceptGroupApplicationRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Accepts an outstanding invitation to to join a group.
void	AcceptGroupInvitation (AcceptGroupInvitationRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Accepts an invitation to join a group.
void	AddMembers (AddMembersRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds members to a group or role.
void	ApplyToGroup (ApplyToGroupRequest request, Action< ApplyToGroupResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Applies to join a group.
void	BlockEntity (BlockEntityRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Blocks a list of entities from joining a group.
void	ChangeMemberRole (ChangeMemberRoleRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Changes the role membership of a list of entities from one role to another.
void	CreateGroup (CreateGroupRequest request, Action< CreateGroupResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates a new group.
void	CreateRole (CreateGroupRoleRequest request, Action< CreateGroupRoleResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates a new group role.
void	DeleteGroup (DeleteGroupRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Deletes a group and all roles, invitations, join requests, and blocks associated with it.
void	DeleteRole (DeleteRoleRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Deletes an existing role in a group.
void	GetGroup (GetGroupRequest request, Action< GetGroupResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Gets information about a group and its roles.
void	InviteToGroup (InviteToGroupRequest request, Action< InviteToGroupResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Invites a player to join a group.
void	IsMember (IsMemberRequest request, Action< IsMemberResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Checks to see if an entity is a member of a group or role within the group.
void	ListGroupApplications (ListGroupApplicationsRequest request, Action< ListGroupApplicationsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all outstanding requests to join a group.
void	ListGroupBlocks (ListGroupBlocksRequest request, Action< ListGroupBlocksResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all entities blocked from joining a group.
void	ListGroupInvitations (ListGroupInvitationsRequest request, Action< ListGroupInvitationsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all outstanding invitations for a group.
void	ListGroupMembers (ListGroupMembersRequest request, Action< ListGroupMembersResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all members for a group.
void	ListMembership (ListMembershipRequest request, Action< ListMembershipResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all groups and roles for an entity.
void	ListMembershipOpportunities (ListMembershipOpportunitiesRequest request, Action< ListMembershipOpportunitiesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all outstanding invitations and group applications for an entity.
void	RemoveGroupApplication (RemoveGroupApplicationRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes an application to join a group.
void	RemoveGroupInvitation (RemoveGroupInvitationRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes an invitation join a group.
void	RemoveMembers (RemoveMembersRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes members from a group.
void	UnblockEntity (UnblockEntityRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unblocks a list of entities from joining a group.
void	UpdateGroup (UpdateGroupRequest request, Action< UpdateGroupResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates non-membership data about a group.
void	UpdateRole (UpdateGroupRoleRequest request, Action< UpdateGroupRoleResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates metadata about a role.

Public Attributes
readonly PlayFabApiSettings	apiSettings = null
readonly PlayFabAuthenticationContext	authenticationContext = null

Detailed Description

The Groups API is designed for any permanent or semi-permanent collections of Entities (players, or non-players). If you want to make Guilds/Clans/Corporations/etc., then you should use groups. Groups can also be used to make chatrooms, parties, or any other persistent collection of entities.

---

The documentation for this class was generated from the following file:

• C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/PlayFabSDK/Groups/PlayFabGroupsInstanceAPI.cs