Client Group API Reference
PGOS Group is a service to create a persistent grouping mechanism for players to chat and interact with each other. A player can create or join in multiple groups. Roles of group members are provided to implement various group management features.
API List
| API | Description |
|---|---|
| CreateGroup | Creat a new group. |
| SearchGroup | Search for groups that meet the specified criteria. |
| GetMyGroupList | Get all my joined groups |
| GetGroupInfo | Get information for the group. These data can be accessed by non-group members. |
| BatchGetGroupInfo | Get information for batch of groups (max 100 groups). These data can be accessed by non-group members. |
| GetGroupDetail | Get detail information for the group. These data can only be accessed by group members. |
| BatchGetGroupDetail | Get detail information for batch of groups (max 100 groups). These data can only be accessed by group members. |
| GetGroupMembers | Get members for the group. |
| GetGroupMember | Get a member of a group. |
| JoinGroup | Request to join a group. The request will failed if the join rule of the group is not Anyone. |
| LeaveGroup | Leave the group. |
| InvitePlayersToGroup | Invite some players to the group. Each player be invited will receive a OnGroupInvitation event. |
| GetGroupInvitations | Get a list of group invitations which is neither be rejected nor be accepted. |
| AcceptGroupInvitation | Accept a group invitation. |
| RejectGroupInvitation | Reject a group invitation. |
| SetMyGroupNickname | Set player's nickname of the group. |
| SetGroupName | Set name of the group. Group name could only be set by the group owner. |
| SetGroupIcon | Set icon info of the group. Group icon could only be set by the group owner. |
| SetGroupDesc | Set description of the group. Group description could only be set by the group owner or administrator. |
| SetGroupAnnouncement | Set announcement of the group. Group announcement could only be set by the group owner or administrator. |
| SetGroupTags | Set tags of the group. Group tags could only be set by the group owner or administrator. |
| SetGroupJoinRule | Set join rule of the group. Group join rule could only be set by the group owner or administrator. |
| SetGroupPublic | Set public strategy of the group. Group public strategy could only be set by the group owner or administrator. |
| SetGroupMemberRemark | Group owner and group administrator could use this api to set a group member's remark. |
| BatchSetGroupMemberRemark | Batch set remark for group members (max 100 players). |
| RemoveGroupMember | Remove a group member from the group. |
| BatchRemoveGroupMembers | Remove a list of group members from the group. (max 100 players) |
| MuteGroupMember | Mute a group member of the group. The muted group member cannot send message to group chat. |
| UnmuteGroupMember | Unmute a group member of the group. |
| TransferGroupOwnership | Transfer group ownership to a group member. |
| GrantGroupAdmin | Grant group administrator rights to a group member. |
| RevokeGroupAdmin | Revoke group administrator rights from a group member. |
| GetGroupDiscoveryList | Paging to get the number of group discoveries. You can additionally obtain the specified number of recommendation groups configured on the portal. |
| DismissGroup | Dismiss the group. |
| SendGroupTextMsg | Send group chat text message |
| SendGroupCustomMsg | Send group chat custom message |
| GetGroupMsgList | Get chat message list in a group |
| ActiveGroupChat | Set the current group chat. When setting, OnUnreadGroupMsgCountNotifyEvt will be pushed, and subsequent group chat messages currently in progress are automatically marked as read |
| GetActiveGroupChat | Get the current group chat. |
| GetGroupMentionedInfo | Get latest record mentioning me in the group. |
| ClearGroupMentionedInfo | Clear record mentioning me in the group. |
| ClearGroupUnreadCount | Mark messages in group as all read |
| ClearGroupChatMsg | Clear the group's local message records |
| SetGroupGlobalCustomData | Add or modify global custom data of a group. For group owner or administrators only. |
| DelGroupGlobalCustomData | Delete keys from global custom data of a group. For group owner or administrators only. |
| ClearGroupGlobalCustomData | Clear all global custom data of a group. For group owner or administrators only. |
| SetGroupMyPlayerCustomData | Modify group custom data for custom player. |
| BatchSetGroupPlayerCustomData | Modify group custom data for batch players (max 1000 players). Only group owner and administrators can modify other people's group custom data. |
Event List
| Event | Description |
|---|---|
| OnGroupInvitation | The event will be triggered when received a group invitation. |
| OnRemovedFromGroup | The event will be triggered when player is removed from the group. |
| OnMutedInGroup | The event will be triggered when player is muted in the group. |
| OnUnmutedInGroup | The event will be triggered when player is unmuted in the group. |
| OnGroupDismissed | The event will be triggered when the group is dismissed by group owner. |
| OnBadgeNumOfGroupInvitation | The event will be triggered when player login PGOS or the list of group invitation received changes. |
| OnUnreadGroupMsgCountNotify | The event will be triggered after login PGOS and when the unread count of group message changed. |
| OnReceiveGroupMsg | The event will be triggered when receive group chat message. |
| OnGroupNewMentioned | The event will be triggered when a new mention of a group is received. |
| OnGlobalCustomDataChanged | The event will be triggered when group global custom data changed. |
| OnPlayerCustomDataChanged | The event will be triggered when a group member custom changed. |
API Details
CreateGroup
Creat a new group.
/// <summary>Creat a new group.</summary>
/// <param name="pgos_params">
/// </param>
public void CreateGroup(CreateGroupParams pgos_params, GroupDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | CreateGroupParams | |
| callback | GroupDelegate0 |
Return: void
SearchGroup
Search for groups that meet the specified criteria.
/// <summary>Search for groups that meet the specified criteria.</summary>
/// <param name="pgos_params">
/// </param>
public void SearchGroup(SearchGroupParams pgos_params, GroupDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SearchGroupParams | |
| callback | GroupDelegate1 |
Return: void
GetMyGroupList
Get all my joined groups
/// <summary>Get all my joined groups</summary>
public void GetMyGroupList(GroupDelegate2 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| callback | GroupDelegate2 |
Return: void
GetGroupInfo
Get information for the group. These data can be accessed by non-group members.
/// <summary>Get information for the group. These data can be accessed by non-group members.</summary>
/// <param name="group_id">
/// </param>
public void GetGroupInfo(string group_id, GroupDelegate3 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate3 |
Return: void
BatchGetGroupInfo
Get information for batch of groups (max 100 groups). These data can be accessed by non-group members.
/// <summary>Get information for batch of groups (max 100 groups). These data can be accessed by non-group members.</summary>
/// <param name="group_ids">
/// </param>
public void BatchGetGroupInfo(List<string> group_ids, GroupDelegate4 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_ids | List<string> | |
| callback | GroupDelegate4 |
Return: void
GetGroupDetail
Get detail information for the group. These data can only be accessed by group members.
/// <summary>Get detail information for the group. These data can only be accessed by group members.</summary>
/// <param name="group_id">
/// </param>
public void GetGroupDetail(string group_id, GroupDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate0 |
Return: void
BatchGetGroupDetail
Get detail information for batch of groups (max 100 groups). These data can only be accessed by group members.
/// <summary>Get detail information for batch of groups (max 100 groups). These data can only be accessed by group members.</summary>
/// <param name="group_ids">
/// </param>
public void BatchGetGroupDetail(List<string> group_ids, GroupDelegate5 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_ids | List<string> | |
| callback | GroupDelegate5 |
Return: void
GetGroupMembers
Get members for the group.
/// <summary>Get members for the group.</summary>
/// <param name="group_id">
/// </param>
public void GetGroupMembers(string group_id, GroupDelegate6 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate6 |
Return: void
GetGroupMember
Get a member of a group.
/// <summary>Get a member of a group.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
public void GetGroupMember(string group_id, string player_id, GroupDelegate7 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| callback | GroupDelegate7 |
Return: void
JoinGroup
Request to join a group. The request will failed if the join rule of the group is not Anyone.
/// <summary>Request to join a group. The request will failed if the join rule of the group is not Anyone.</summary>
/// <param name="group_id">
/// </param>
public void JoinGroup(string group_id, GroupDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate0 |
Return: void
LeaveGroup
Leave the group.
/// <summary>Leave the group.</summary>
/// <param name="group_id">
/// </param>
public void LeaveGroup(string group_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate8 |
Return: void
InvitePlayersToGroup
Invite some players to the group. Each player be invited will receive a OnGroupInvitation event.
/// <summary>Invite some players to the group. Each player be invited will receive a OnGroupInvitation event.</summary>
/// <param name="pgos_params">
/// </param>
public void InvitePlayersToGroup(InvitePlayersToGroupParams pgos_params, GroupDelegate9 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | InvitePlayersToGroupParams | |
| callback | GroupDelegate9 |
Return: void
GetGroupInvitations
Get a list of group invitations which is neither be rejected nor be accepted.
/// <summary>Get a list of group invitations which is neither be rejected nor be accepted.</summary>
public void GetGroupInvitations(GroupDelegate10 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| callback | GroupDelegate10 |
Return: void
AcceptGroupInvitation
Accept a group invitation.
/// <summary>Accept a group invitation.</summary>
/// <param name="group_id">
/// </param>
/// <param name="invitation_id">
/// </param>
public void AcceptGroupInvitation(string group_id, string invitation_id, GroupDelegate11 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| invitation_id | string | |
| callback | GroupDelegate11 |
Return: void
RejectGroupInvitation
Reject a group invitation.
/// <summary>Reject a group invitation.</summary>
/// <param name="group_id">
/// </param>
/// <param name="invitation_id">
/// </param>
public void RejectGroupInvitation(string group_id, string invitation_id, GroupDelegate12 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| invitation_id | string | |
| callback | GroupDelegate12 |
Return: void
SetMyGroupNickname
Set player's nickname of the group.
/// <summary>Set player's nickname of the group.</summary>
/// <param name="pgos_params">
/// </param>
public void SetMyGroupNickname(SetMyGroupNicknameParams pgos_params, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetMyGroupNicknameParams | |
| callback | GroupDelegate8 |
Return: void
SetGroupName
Set name of the group. Group name could only be set by the group owner.
/// <summary>Set name of the group. Group name could only be set by the group owner.</summary>
/// <param name="pgos_params">
/// </param>
public void SetGroupName(SetGroupNameParams pgos_params, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupNameParams | |
| callback | GroupDelegate13 |
Return: void
SetGroupIcon
Set icon info of the group. Group icon could only be set by the group owner.
/// <summary>Set icon info of the group. Group icon could only be set by the group owner.</summary>
/// <param name="group_id">
/// </param>
/// <param name="group_icon">
/// </param>
public void SetGroupIcon(string group_id, string group_icon, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| group_icon | string | |
| callback | GroupDelegate13 |
Return: void
SetGroupDesc
Set description of the group. Group description could only be set by the group owner or administrator.
/// <summary>Set description of the group. Group description could only be set by the group owner or administrator.</summary>
/// <param name="pgos_params">
/// </param>
public void SetGroupDesc(SetGroupDescParams pgos_params, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupDescParams | |
| callback | GroupDelegate13 |
Return: void
SetGroupAnnouncement
Set announcement of the group. Group announcement could only be set by the group owner or administrator.
/// <summary>Set announcement of the group. Group announcement could only be set by the group owner or administrator.</summary>
/// <param name="pgos_params">
/// </param>
public void SetGroupAnnouncement(SetGroupAnnouncementParams pgos_params, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupAnnouncementParams | |
| callback | GroupDelegate13 |
Return: void
SetGroupTags
Set tags of the group. Group tags could only be set by the group owner or administrator.
/// <summary>Set tags of the group. Group tags could only be set by the group owner or administrator.</summary>
/// <param name="pgos_params">
/// </param>
public void SetGroupTags(SetGroupTagsParams pgos_params, GroupDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupTagsParams | |
| callback | GroupDelegate0 |
Return: void
SetGroupJoinRule
Set join rule of the group. Group join rule could only be set by the group owner or administrator.
/// <summary>Set join rule of the group. Group join rule could only be set by the group owner or administrator.</summary>
/// <param name="group_id">
/// </param>
/// <param name="join_rule">
/// </param>
public void SetGroupJoinRule(string group_id, GroupJoinRule join_rule, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| join_rule | GroupJoinRule | |
| callback | GroupDelegate13 |
Return: void
SetGroupPublic
Set public strategy of the group. Group public strategy could only be set by the group owner or administrator.
/// <summary>Set public strategy of the group. Group public strategy could only be set by the group owner or administrator.</summary>
/// <param name="group_id">
/// </param>
/// <param name="is_public">
/// </param>
public void SetGroupPublic(string group_id, bool is_public, GroupDelegate13 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| is_public | bool | |
| callback | GroupDelegate13 |
Return: void
SetGroupMemberRemark
Group owner and group administrator could use this api to set a group member's remark.
/// <summary>Group owner and group administrator could use this api to set a group member's remark.</summary>
/// <param name="pgos_params">
/// </param>
public void SetGroupMemberRemark(SetGroupMemberRemarkParams pgos_params, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupMemberRemarkParams | |
| callback | GroupDelegate8 |
Return: void
BatchSetGroupMemberRemark
Batch set remark for group members (max 100 players).
/// <summary>Batch set remark for group members (max 100 players).</summary>
/// <param name="pgos_params">
/// </param>
public void BatchSetGroupMemberRemark(BatchSetGroupMemberRemarkParams pgos_params, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | BatchSetGroupMemberRemarkParams | |
| callback | GroupDelegate8 |
Return: void
RemoveGroupMember
Remove a group member from the group.
/// <summary>Remove a group member from the group.</summary>
/// <param name="group_id">Group id</param>
/// <param name="player_id">Player to remove</param>
public void RemoveGroupMember(string group_id, string player_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | Group id |
| player_id | string | Player to remove |
| callback | GroupDelegate8 |
Return: void
BatchRemoveGroupMembers
Remove a list of group members from the group. (max 100 players)
/// <summary>Remove a list of group members from the group. (max 100 players)</summary>
/// <param name="group_id">Group id</param>
/// <param name="player_ids">Players to remove</param>
public void BatchRemoveGroupMembers(string group_id, List<string> player_ids, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | Group id |
| player_ids | List<string> | Players to remove |
| callback | GroupDelegate8 |
Return: void
MuteGroupMember
Mute a group member of the group. The muted group member cannot send message to group chat.
/// <summary>Mute a group member of the group. The muted group member cannot send message to group chat.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
/// <param name="mute_duration_minutes">The duration of the member has been muted. 0 means muted forever.</param>
public void MuteGroupMember(string group_id, string player_id, UInt32 mute_duration_minutes, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| mute_duration_minutes | UInt32 | The duration of the member has been muted. 0 means muted forever. |
| callback | GroupDelegate8 |
Return: void
UnmuteGroupMember
Unmute a group member of the group.
/// <summary>Unmute a group member of the group.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
public void UnmuteGroupMember(string group_id, string player_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| callback | GroupDelegate8 |
Return: void
TransferGroupOwnership
Transfer group ownership to a group member.
/// <summary>Transfer group ownership to a group member.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
public void TransferGroupOwnership(string group_id, string player_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| callback | GroupDelegate8 |
Return: void
GrantGroupAdmin
Grant group administrator rights to a group member.
/// <summary>Grant group administrator rights to a group member.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
public void GrantGroupAdmin(string group_id, string player_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| callback | GroupDelegate8 |
Return: void
RevokeGroupAdmin
Revoke group administrator rights from a group member.
/// <summary>Revoke group administrator rights from a group member.</summary>
/// <param name="group_id">
/// </param>
/// <param name="player_id">
/// </param>
public void RevokeGroupAdmin(string group_id, string player_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| player_id | string | |
| callback | GroupDelegate8 |
Return: void
GetGroupDiscoveryList
Paging to get the number of group discoveries. You can additionally obtain the specified number of recommendation groups configured on the portal.
/// <summary>Paging to get the number of group discoveries. You can additionally obtain the specified number of recommendation groups configured on the portal.</summary>
/// <param name="pgos_params">
/// </param>
public void GetGroupDiscoveryList(GetGroupDiscoveryListParams pgos_params, GroupDelegate14 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | GetGroupDiscoveryListParams | |
| callback | GroupDelegate14 |
Return: void
DismissGroup
Dismiss the group.
/// <summary>Dismiss the group.</summary>
/// <param name="group_id">
/// </param>
public void DismissGroup(string group_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | |
| callback | GroupDelegate8 |
Return: void
SendGroupTextMsg
Send group chat text message
/// <summary>Send group chat text message</summary>
/// <param name="pgos_params">Request struct for sending text message</param>
public void SendGroupTextMsg(SendGroupMsgParams pgos_params, GroupDelegate15 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SendGroupMsgParams | Request struct for sending text message |
| callback | GroupDelegate15 |
Return: void
SendGroupCustomMsg
Send group chat custom message
/// <summary>Send group chat custom message</summary>
/// <param name="pgos_params">Request struct for sending custom message</param>
public void SendGroupCustomMsg(SendGroupMsgParams pgos_params, GroupDelegate15 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SendGroupMsgParams | Request struct for sending custom message |
| callback | GroupDelegate15 |
Return: void
GetGroupMsgList
Get chat message list in a group
/// <summary>Get chat message list in a group</summary>
/// <param name="group_id">The group ID</param>
/// <param name="start_seq">The start sequence number of the message to query, 0 means start from the latest message.</param>
/// <param name="count">The count of message to get</param>
public void GetGroupMsgList(string group_id, Int64 start_seq, Int32 count, GroupDelegate16 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | The group ID |
| start_seq | Int64 | The start sequence number of the message to query, 0 means start from the latest message. |
| count | Int32 | The count of message to get |
| callback | GroupDelegate16 |
Return: void
ActiveGroupChat
Set the current group chat. When setting, OnUnreadGroupMsgCountNotifyEvt will be pushed, and subsequent group chat messages currently in progress are automatically marked as read
/// <summary>Set the current group chat. When setting, OnUnreadGroupMsgCountNotifyEvt will be pushed, and subsequent group chat messages currently in progress are automatically marked as read</summary>
/// <param name="group_id">The group to set as active</param>
public void ActiveGroupChat(string group_id);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | The group to set as active |
Return: void
GetActiveGroupChat
Get the current group chat.
/// <summary>Get the current group chat.</summary>
public string GetActiveGroupChat();
Parameters:
(No parameters)
Return: string
Player ID of current group chat
GetGroupMentionedInfo
Get latest record mentioning me in the group.
/// <summary>Get latest record mentioning me in the group.</summary>
/// <param name="group_id">Group ID.</param>
/// <param name="dst">The latest record mentioned me.</param>
public bool GetGroupMentionedInfo(string group_id, ref GroupMentionedInfo dst);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | Group ID. |
| dst | ref GroupMentionedInfo | The latest record mentioned me. |
Return: bool
True if there are any mentions of me.
ClearGroupMentionedInfo
Clear record mentioning me in the group.
/// <summary>Clear record mentioning me in the group.</summary>
/// <param name="group_id">Group ID. If empty, it means all groups</param>
public void ClearGroupMentionedInfo(string group_id);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | Group ID. If empty, it means all groups |
Return: void
ClearGroupUnreadCount
Mark messages in group as all read
/// <summary>Mark messages in group as all read</summary>
/// <param name="group_id">The group ID. If empty, it means all groups</param>
public void ClearGroupUnreadCount(string group_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | The group ID. If empty, it means all groups |
| callback | GroupDelegate8 |
Return: void
ClearGroupChatMsg
Clear the group's local message records
/// <summary>Clear the group's local message records</summary>
/// <param name="group_id">The group ID. If empty, it means all groups</param>
public void ClearGroupChatMsg(string group_id, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| group_id | string | The group ID. If empty, it means all groups |
| callback | GroupDelegate8 |
Return: void
SetGroupGlobalCustomData
Add or modify global custom data of a group. For group owner or administrators only.
/// <summary>Add or modify global custom data of a group. For group owner or administrators only.</summary>
public void SetGroupGlobalCustomData(SetGroupGlobalCustomDataParams pgos_params, GroupDelegate17 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupGlobalCustomDataParams | |
| callback | GroupDelegate17 |
Return: void
DelGroupGlobalCustomData
Delete keys from global custom data of a group. For group owner or administrators only.
/// <summary>Delete keys from global custom data of a group. For group owner or administrators only.</summary>
public void DelGroupGlobalCustomData(DelGroupGlobalCustomDataParams pgos_params, GroupDelegate18 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | DelGroupGlobalCustomDataParams | |
| callback | GroupDelegate18 |
Return: void
ClearGroupGlobalCustomData
Clear all global custom data of a group. For group owner or administrators only.
/// <summary>Clear all global custom data of a group. For group owner or administrators only.</summary>
public void ClearGroupGlobalCustomData(ClearGroupGlobalCustomDataParams pgos_params, GroupDelegate8 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | ClearGroupGlobalCustomDataParams | |
| callback | GroupDelegate8 |
Return: void
SetGroupMyPlayerCustomData
Modify group custom data for custom player.
/// <summary>Modify group custom data for custom player.</summary>
public void SetGroupMyPlayerCustomData(SetGroupMyPlayerCustomDataParams pgos_params, GroupDelegate19 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | SetGroupMyPlayerCustomDataParams | |
| callback | GroupDelegate19 |
Return: void
BatchSetGroupPlayerCustomData
Modify group custom data for batch players (max 1000 players). Only group owner and administrators can modify other people's group custom data.
/// <summary>Modify group custom data for batch players (max 1000 players). Only group owner and administrators can modify other people's group custom data.</summary>
public void BatchSetGroupPlayerCustomData(BatchSetGroupPlayerCustomDataParams pgos_params, GroupDelegate20 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| pgos_params | BatchSetGroupPlayerCustomDataParams | |
| callback | GroupDelegate20 |
Return: void
Event Details
OnGroupInvitation
The event will be triggered when received a group invitation.
/// <summary>The event will be triggered when received a group invitation.</summary>
public event GroupDelegate21 OnGroupInvitation;
Type Reference:
OnRemovedFromGroup
The event will be triggered when player is removed from the group.
/// <summary>The event will be triggered when player is removed from the group.</summary>
public event GroupDelegate22 OnRemovedFromGroup;
Type Reference:
OnMutedInGroup
The event will be triggered when player is muted in the group.
/// <summary>The event will be triggered when player is muted in the group.</summary>
public event GroupDelegate23 OnMutedInGroup;
Type Reference:
OnUnmutedInGroup
The event will be triggered when player is unmuted in the group.
/// <summary>The event will be triggered when player is unmuted in the group.</summary>
public event GroupDelegate24 OnUnmutedInGroup;
Type Reference:
OnGroupDismissed
The event will be triggered when the group is dismissed by group owner.
/// <summary>The event will be triggered when the group is dismissed by group owner.</summary>
public event GroupDelegate25 OnGroupDismissed;
Type Reference:
OnBadgeNumOfGroupInvitation
The event will be triggered when player login PGOS or the list of group invitation received changes.
/// <summary>The event will be triggered when player login PGOS or the list of group invitation received changes.</summary>
public event GroupDelegate26 OnBadgeNumOfGroupInvitation;
Type Reference:
OnUnreadGroupMsgCountNotify
The event will be triggered after login PGOS and when the unread count of group message changed.
/// <summary>The event will be triggered after login PGOS and when the unread count of group message changed.</summary>
public event GroupDelegate27 OnUnreadGroupMsgCountNotify;
Type Reference:
OnReceiveGroupMsg
The event will be triggered when receive group chat message.
/// <summary>The event will be triggered when receive group chat message.</summary>
public event GroupDelegate28 OnReceiveGroupMsg;
Type Reference:
OnGroupNewMentioned
The event will be triggered when a new mention of a group is received.
/// <summary>The event will be triggered when a new mention of a group is received.</summary>
public event GroupDelegate29 OnGroupNewMentioned;
Type Reference:
OnGlobalCustomDataChanged
The event will be triggered when group global custom data changed.
/// <summary>The event will be triggered when group global custom data changed.</summary>
public event GroupDelegate30 OnGlobalCustomDataChanged;
Type Reference:
OnPlayerCustomDataChanged
The event will be triggered when a group member custom changed.
/// <summary>The event will be triggered when a group member custom changed.</summary>
public event GroupDelegate31 OnPlayerCustomDataChanged;
Type Reference:
All Delegates
public delegate void GroupDelegate0(PgosResult a0, GroupDetail a1);
public delegate void GroupDelegate1(PgosResult a0, SearchGroupRsp a1);
public delegate void GroupDelegate2(PgosResult a0, GetMyGroupListResult a1);
public delegate void GroupDelegate3(PgosResult a0, GroupInfo a1);
public delegate void GroupDelegate4(PgosResult a0, BatchGetGroupInfoRsp a1);
public delegate void GroupDelegate5(PgosResult a0, BatchGetGroupDetailRsp a1);
public delegate void GroupDelegate6(PgosResult a0, GetGroupMembersRsp a1);
public delegate void GroupDelegate7(PgosResult a0, GetGroupMemberRsp a1);
public delegate void GroupDelegate8(PgosResult a0);
public delegate void GroupDelegate9(PgosResult a0, InvitePlayersToGroupRsp a1);
public delegate void GroupDelegate10(PgosResult a0, List<GroupInvitation> a1);
public delegate void GroupDelegate11(PgosResult a0, AcceptGroupInvitationRsp a1);
public delegate void GroupDelegate12(PgosResult a0, RejectGroupInvitationRsp a1);
public delegate void GroupDelegate13(PgosResult a0, UpdateGroupRsp a1);
public delegate void GroupDelegate14(PgosResult a0, GetGroupDiscoveryListResult a1);
public delegate void GroupDelegate15(PgosResult a0, SendGroupMsgResult a1);
public delegate void GroupDelegate16(PgosResult a0, GetGroupChatMsgListResult a1);
public delegate void GroupDelegate17(PgosResult a0, SetGroupGlobalCustomDataResult a1);
public delegate void GroupDelegate18(PgosResult a0, DelGroupGlobalCustomDataResult a1);
public delegate void GroupDelegate19(PgosResult a0, SetGroupMyPlayerCustomDataResult a1);
public delegate void GroupDelegate20(PgosResult a0, BatchSetGroupPlayerCustomDataResult a1);
public delegate void GroupDelegate21(GroupInvitationEvt a0);
public delegate void GroupDelegate22(RemovedFromGroupEvt a0);
public delegate void GroupDelegate23(MutedInGroupEvt a0);
public delegate void GroupDelegate24(UnmutedInGroupEvt a0);
public delegate void GroupDelegate25(GroupDismissedEvt a0);
public delegate void GroupDelegate26(BadgeNumOfGroupInvitationEvt a0);
public delegate void GroupDelegate27(UnreadMsgCountNotifyEvt a0);
public delegate void GroupDelegate28(ReceiveGroupMsgEvt a0);
public delegate void GroupDelegate29(GroupNewMentionedEvt a0);
public delegate void GroupDelegate30(GroupGlobalCustomDataChangedEvt a0);
public delegate void GroupDelegate31(GroupPlayerCustomDataChangedEvt a0);
Type Reference:
- PgosResult
- GroupDetail
- SearchGroupRsp
- GetMyGroupListResult
- GroupInfo
- BatchGetGroupInfoRsp
- BatchGetGroupDetailRsp
- GetGroupMembersRsp
- GetGroupMemberRsp
- InvitePlayersToGroupRsp
- AcceptGroupInvitationRsp
- RejectGroupInvitationRsp
- UpdateGroupRsp
- GetGroupDiscoveryListResult
- SendGroupMsgResult
- GetGroupChatMsgListResult
- SetGroupGlobalCustomDataResult
- DelGroupGlobalCustomDataResult
- SetGroupMyPlayerCustomDataResult
- BatchSetGroupPlayerCustomDataResult
- GroupInvitationEvt
- RemovedFromGroupEvt
- MutedInGroupEvt
- UnmutedInGroupEvt
- GroupDismissedEvt
- BadgeNumOfGroupInvitationEvt
- UnreadMsgCountNotifyEvt
- ReceiveGroupMsgEvt
- GroupNewMentionedEvt
- GroupGlobalCustomDataChangedEvt
- GroupPlayerCustomDataChangedEvt