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...
Public Attributes | |
| bool? | AutoAcceptOutstandingApplication |
| Optional, default true. Automatically accept an application if one exists instead of creating an invitation. | |
| Dictionary< string, string > | CustomTags |
| The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). | |
| EntityKey | Entity |
| The entity to perform this action on. | |
| EntityKey | Group |
| The identifier of the group. | |
| string | RoleId |
| Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this is not specified. Role IDs must be between 1 and 64 characters long. | |
 Public Attributes inherited from PlayFab.SharedModels.PlayFabRequestCommon | |
| PlayFabAuthenticationContext | AuthenticationContext |
Additional Inherited Members | |
| Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel | |
| string | ToJson () |
Detailed Description
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.
The documentation for this class was generated from the following file:
- C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/PlayFabSDK/Groups/PlayFabGroupsModels.cs
