Chat SDK for Unity and Windows v1.2.0
Public Member Functions | Public Attributes | List of all members
AgoraChat.GroupOptions Class Reference
Inheritance diagram for AgoraChat.GroupOptions:

Public Member Functions

 GroupOptions (GroupStyle style, int count=200, bool inviteNeedConfirm=false, string ext=null)
 

Public Attributes

GroupStyle Style
 
int MaxCount
 
bool InviteNeedConfirm
 
string Ext
 

Constructor & Destructor Documentation

◆ GroupOptions()

AgoraChat.GroupOptions.GroupOptions ( GroupStyle  style,
int  count = 200,
bool  inviteNeedConfirm = false,
string  ext = null 
)

The group option class constructor.

Member Data Documentation

◆ Style

GroupStyle AgoraChat.GroupOptions.Style

The group style. See GroupStyle.

◆ MaxCount

int AgoraChat.GroupOptions.MaxCount

The maximum number of members allowed in a group.

◆ InviteNeedConfirm

bool AgoraChat.GroupOptions.InviteNeedConfirm

Whether to ask for consent when inviting a user to join a group.

Whether automatically accepting the invitation to join a group depends on two settings:

  • inviteNeedConfirm, an option for group creation.
  • Options#AutoAcceptGroupInvitation which determines whether to automatically accept an invitation to join the group.

There are two cases:

  • If inviteNeedConfirm is set to false, the SDK adds the invitee directly to the group on the server side, regardless of the setting of Options#AutoAcceptGroupInvitation on the invitee side.
  • If inviteNeedConfirm is set to true, whether the invitee automatically joins the chat group or not depends on the settings of Options#AutoAcceptGroupInvitation.

Options#AutoAcceptGroupInvitation is an SDK-level operation. If it is set to true, the invitee automatically joins the chat group; if it is set to false, the invitee can manually accept or decline the group invitation instead of joining the group automatically.

◆ Ext

string AgoraChat.GroupOptions.Ext

The group detail extensions which can be in the JSON format to contain more group information.