This class defines the main entry point for the Groups feature. More...
Inheritance diagram for Beamable.Api.Groups.GroupsService:
Collaboration diagram for Beamable.Api.Groups.GroupsService:
Public Member Functions | |
| GroupsService (IPlatformService platform, IBeamableRequester requester) | |
| override Promise< GroupsView > | GetCurrent (string scope="") |
 Public Member Functions inherited from Beamable.Common.Api.Groups.GroupsApi | |
| GroupsApi (IUserContext ctx, IBeamableRequester requester) | |
| Promise< GroupUser > | GetUser (long gamerTag) |
| Promise< Group > | GetGroup (long groupId) |
| Promise< EmptyResponse > | DisbandGroup (long group) |
| Promise< GroupMembershipResponse > | LeaveGroup (long group) |
| Promise< GroupMembershipResponse > | JoinGroup (long group) |
| Promise< EmptyResponse > | Petition (long group) |
| Promise< GroupSearchResponse > | GetRecommendations () |
| 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) |
| Promise< GroupCreateResponse > | CreateGroup (GroupCreateRequest request) |
| Promise< AvailabilityResponse > | CheckAvailability (string name, string tag) |
| Promise< EmptyResponse > | SetGroupProps (long groupId, GroupUpdateProperties props) |
| Promise< GroupMembershipResponse > | Kick (long group, long gamerTag) |
| Promise< EmptyResponse > | SetRole (long group, long gamerTag, string role) |
| Promise< EmptyResponse > | MakeDonationRequest (long group, Currency currency) |
| Promise< EmptyResponse > | Donate (long group, long recipientId, long amount) |
| string | AddQuery (string query, string key, string value) |
| Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< GroupsView > | |
| Promise< TData > | GetCurrent (string scope="") |
Properties | |
| GroupsSubscription | Subscribable [get] |
| Properties inherited from Beamable.Common.Api.Groups.GroupsApi | |
| IUserContext | Ctx [get] |
| IBeamableRequester | Requester [get] |
| Properties inherited from Beamable.Api.IHasPlatformSubscriber< GroupsSubscription, GroupUser, GroupsView > | |
| TPlatformSubscriber | Subscribable [get] |
| Allows scopes to consume fresh data when available. More... | |
Detailed Description
This class defines the main entry point for the Groups feature.
Related Links
- See the Groups feature documentation
- See Beamable.API script reference
The documentation for this class was generated from the following file:
- client/Packages/com.beamable/Runtime/Core/Platform/SDK/Groups/GroupsService.cs
