This type defines the Microservice main entry point for the Groups feature. More...
Inheritance diagram for Beamable.Server.Api.Groups.IMicroserviceGroupsApi:
Collaboration diagram for Beamable.Server.Api.Groups.IMicroserviceGroupsApi:
Additional Inherited Members | |
 Public Member Functions inherited from Beamable.Common.Api.Groups.IGroupsApi | |
| Promise< GroupUser > | GetUser (long gamerTag) |
| Get the GroupUser for a player, which contains all the group metadata the player belongs to. Use the GetGroup method to resolve the full group data. More... | |
| Promise< Group > | GetGroup (long groupId) |
| Get the Group data for some group. The resulting Group structure will be personalized for the current player making the call. More... | |
| Promise< EmptyResponse > | DisbandGroup (long group) |
| Disbanding a group will delete the group data from Beamable. This method can only be called by an admin, from a microservice, or by the group Leader that has the Group.canDisband permission. More... | |
| Promise< GroupMembershipResponse > | LeaveGroup (long group) |
| Remove the current player from a group. After a player leaves, the group will no longer appear in the GetUser method response. More... | |
| Promise< GroupMembershipResponse > | JoinGroup (long group) |
| Add the current player to a group. A player can only join a group when the group's Group.enrollmentType is set to "open". A player can only be in one group at a time. If the player is already in a group, they must use the LeaveGroup method before they can join a new group. More... | |
| Promise< EmptyResponse > | Petition (long group) |
| This will be removed in a future version of Beamable. Please do not use. More... | |
| Promise< GroupSearchResponse > | GetRecommendations () |
| This will be removed in a future version of Beamable. Please do not use. More... | |
| Promise< GroupSearchResponse > | Search (string name=null, List< string > enrollmentTypes=null, bool? hasSlots=null, long? scoreMin=null, long? scoreMax=null, string sortField=null, int? sortValue=null, int? offset=null, int? limit=null) |
| Get a list of Groups that match some criteria. The resulting Group structures will not be personalized to the current player, and as such, the various permission fields should not be trusted. More... | |
| Promise< GroupCreateResponse > | CreateGroup (GroupCreateRequest request) |
| Create a new group. The current player will become the group Leader for the new group. More... | |
| Promise< AvailabilityResponse > | CheckAvailability (string name, string tag) |
| Check if the given name and tag are available to be used. Names and tags are required to be unique, so if another group is already using the name or tag given to the CreateGroup or SetGroupProps methods, those requests will fail. More... | |
| Promise< EmptyResponse > | SetGroupProps (long groupId, GroupUpdateProperties props) |
| Update the group's data. Only the group Leader can update group data. More... | |
| Promise< GroupMembershipResponse > | Kick (long group, long gamerTag) |
| A Member can be kicked from the group if the current player's Member.canKick field is true. The group Leader and all Officers can kick regular group members. Once a member is kicked, they will no longer be a member. More... | |
| Promise< EmptyResponse > | SetRole (long group, long gamerTag, string role) |
| Set a player's role within a group. Valid roles are "leader", "officer", or an empty string. A group can only have 1 Leader, and the request will fail if the SetRole operation would result in 0 group Leaders. A group can have arbitrary many Officers. This method can be used to change the group Leader. The existing group Leader must call this method and assign a different user the role of "leader". The player that is running this method must have sufficient permissions to grant the role. More... | |
| Promise< EmptyResponse > | MakeDonationRequest (long group, Currency currency) |
| Send a request to the rest of the group to request an amount Currency. Other members in the group may decide to donate their personal currency to the requester by calling the Donate method. The status of donations can be observed in the Group.donations list. ATTENTION! For group donations to work, you must configure a GroupDonationsContent content object called "default". After a player makes a donation request, they must wait some number seconds (as configured in the donations.default) before making a new request. More... | |
| Promise< EmptyResponse > | Donate (long group, long recipientId, long amount, bool autoClaim=true) |
| Send an amount of player currency to fulfil a pending donation request. Members of a group can request currency by running the MakeDonationRequest method. The status of donations can be observed in the Group.donations list. ATTENTION! For group donations to work, you must configure a GroupDonationsContent content object called "default". More... | |
| Promise< EmptyResponse > | ClaimDonations (long group) |
| If a player has requested a donation with the MakeDonationRequest method, and other players have donated with the Donate method without autoClaim enabled, then this method must be called by the original player to complete the donation. More... | |
| string | AddQuery (string query, string key, string value) |
| This will be removed in a future version of Beamable. Please do not use. More... | |
| Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< GroupsView > | |
| Promise< TData > | GetCurrent (string scope="") |
| Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More... | |
Detailed Description
This type defines the Microservice main entry point for the Groups feature.
Related Links
- See the Groups feature documentation
- See Beamable.Server.IBeamableServices script reference
The documentation for this interface was generated from the following file:
- com.beamable.server/SharedRuntime/Api/Groups/IMicroserviceGroupsApi.cs
