|
|
long | id |
| | The group id.
|
| |
|
string | name |
| | The name of the group, which must be unique to the group, and at least 3 characters long. The name can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
string | tag |
| | An optional group tag. If the group has a tag, it must be unique. If the group does not have a tag, this field will be null. A tag must be exactly 3 characters. The tag can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
string | slogan |
| | A slogan is a piece of flavor text to give the group some character. Players will expect the slogan to remain fairly constant. The slogan can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
string | motd |
| | The Message Of The Day is a piece of flavor text that can be used to inspire players. Players will expect the motd to change often. The motd can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
string | enrollmentType |
| | Indicates if the group is accepting new members. Valid values include "open", "closed", or "restricted". The enrollment can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
long | requirement |
| | This will be removed in a future version of Beamable. Please do not use.
|
| |
|
int | maxSize |
| | The maximum number of players that can be in the group. Once the limit is reached, no new members will be allowed to join until existing members leave.
|
| |
|
List< Member > | members |
| | A list of Members in the group from the perspective of the current player. The Member.canDemote, Member.canPromote, and Member.canKick fields indicate if the current player can perform the associated actions on the given member.
|
| |
|
List< SubGroup > | subGroups |
| | A list of SubGroups associated with the group.
|
| |
|
string | clientData |
| | A general purpose string that can be used to fulfil developer needs. The clientData can be updated by the group Leader with the IGroupsApi.SetGroupProps method.
|
| |
|
long | created |
| | A timestamp representing when the group was first created. The number of milliseconds from 1970-01-01T00:00:00Z.
|
| |
|
int | freeSlots |
| | The number of members that can join before the group is full. This is always equal to the maxSize minus the current group size.
|
| |
|
bool | canDisband |
| | true if the current player has the ability to disband the group. Only the group Leader has the ability to disband a group. A group can be disbanded with the IGroupsApi.DisbandGroup method.
|
| |
|
bool | canUpdateEnrollment |
| | true if the current player has the ability to update the group's enrollmentType. Only the group Leader has the ability to update the enrollmentType. A group's enrollmentType can be updated with the IGroupsApi.SetGroupProps method.
|
| |
|
bool | canUpdateMOTD |
| | true if the current player has the ability to update the group's motd. Only the group Leader has the ability to update the motd. A group's motd can be updated with the IGroupsApi.SetGroupProps method.
|
| |
|
bool | canUpdateSlogan |
| | true if the current player has the ability to update the group's slogan. Only the group Leader has the ability to update the slogan. A group's slogan can be updated with the IGroupsApi.SetGroupProps method.
|
| |
|
List< DonationRequest > | donations |
| | A set of DonationRequests that are currently pending in the group. DonationRequests allow group members to ask for and receive currency from other group members.
|
| |
