Group Service Events 1.0.0 documentation
Table of Contents
- Operations
- PUB groupMember.groupMemberInvited
- PUB groupMember.groupMemberJoinRequested
- PUB groupMember.groupMemberJoinAccepted
- PUB groupMember.groupMemberJoinRejected
- PUB group.groupCreated
- PUB group.groupUpdated
- PUB group.groupCustomRulesUpdated
- PUB group.groupDeleted
- PUB group.groupPredefinedRulesUpdated
- PUB group.groupPredefinedRulesDeleted
- PUB groupRoles.groupRoleAssigned
- PUB groupRoles.groupRoleRemoved
- PUB groupMember.groupMemberInvitationAccepted
- PUB groupMember.groupMemberInvitationRejected
- PUB groupMember.groupMemberLeft
- PUB groupMember.groupMemberJoinRequestCanceled
- PUB groupMember.groupMemberKicked
- PUB groupMember.groupMemberInvitationMemberCanceled
Operations
PUB groupMember.groupMemberInvited
Operation
Inform about a user invited to join a group
Message groupMemberInvited
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
invitedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"requesterUserId": "string",
"invitedUserId": "string"
}
PUB groupMember.groupMemberJoinRequested
Operation
Inform about a user submit request to join a group
Message groupMemberJoinRequested
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
adminIds | array<string> | - | - | - | - |
adminIds (single item) | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"adminIds": [
"string"
],
"userId": "string"
}
PUB groupMember.groupMemberJoinAccepted
Operation
Inform about user's join group request accepted
Message groupMemberJoinAccepted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
acceptedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"requesterUserId": "string",
"acceptedUserId": "string"
}
PUB groupMember.groupMemberJoinRejected
Operation
Inform about user's join group request rejected
Message groupMemberJoinRejected
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
rejectedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"requesterUserId": "string",
"rejectedUserId": "string"
}
PUB group.groupCreated
Operation
Inform about created new group
Message groupCreated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
groupDescription | string | - | - | - | - |
groupIcon | string | - | - | - | - |
groupRegion | string | - | - | - | - |
groupType | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"groupDescription": "string",
"groupIcon": "string",
"groupRegion": "string",
"groupType": "string",
"userId": "string"
}
PUB group.groupUpdated
Operation
Inform about group updated
Message groupUpdated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
groupDescription | string | - | - | - | - |
groupIcon | string | - | - | - | - |
groupRegion | string | - | - | - | - |
groupType | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"groupDescription": "string",
"groupIcon": "string",
"groupRegion": "string",
"groupType": "string",
"userId": "string"
}
PUB group.groupCustomRulesUpdated
Operation
Inform about group Custom Rules Updated
Message groupCustomRulesUpdated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
groupCustomRules | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"groupCustomRules": "string",
"userId": "string"
}
PUB group.groupDeleted
Operation
Inform about group Deleted
Message groupDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"userId": "string"
}
PUB group.groupPredefinedRulesUpdated
Operation
Inform about group Predefined Rules Updated
Message groupPredefinedRulesUpdated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
groupPredefinedRules | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"groupPredefinedRules": "string",
"userId": "string"
}
PUB group.groupPredefinedRulesDeleted
Operation
Inform about group Predefined Rules Deleted
Message groupPredefinedRulesDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
groupPredefinedRules | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"groupPredefinedRules": "string",
"userId": "string"
}
PUB groupRoles.groupRoleAssigned
Operation
Inform about assigned user's for specific group roles
Message groupRoleAssigned
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
memberRoleId | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
assignedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"memberRoleId": "string",
"requesterUserId": "string",
"assignedUserId": "string"
}
PUB groupRoles.groupRoleRemoved
Operation
Inform about removed user's for specific group roles
Message groupRoleRemoved
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
memberRoleId | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
removedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"memberRoleId": "string",
"requesterUserId": "string",
"removedUserId": "string"
}
PUB groupMember.groupMemberInvitationAccepted
Operation
Inform about user accept invitation to the specific group
Message groupMemberInvitationAccepted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"userId": "string"
}
PUB groupMember.groupMemberInvitationRejected
Operation
Inform about user reject invitation to the specific group
Message groupMemberInvitationRejected
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"userId": "string"
}
PUB groupMember.groupMemberLeft
Operation
Inform about user left from the group
Message groupMemberLeft
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"userId": "string"
}
PUB groupMember.groupMemberJoinRequestCanceled
Operation
Inform about cancel request to join group
Message groupMemberJoinRequestCanceled
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
userId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"userId": "string"
}
PUB groupMember.groupMemberKicked
Operation
Inform about kicked user member to the specific group
Message groupMemberKicked
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
kickedUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"requesterUserId": "string",
"kickedUserId": "string"
}
PUB groupMember.groupMemberInvitationMemberCanceled
Operation
Inform about cancel invitation group member
Message groupMemberInvitationMemberCanceled
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object | - | - | - | additional properties are allowed |
namespace | string | - | - | - | - |
groupId | string | - | - | - | - |
groupName | string | - | - | - | - |
requesterUserId | string | - | - | - | - |
cancelledUserId | string | - | - | - | - |
Examples of payload (generated)
{
"namespace": "string",
"groupId": "string",
"groupName": "string",
"requesterUserId": "string",
"cancelledUserId": "string"
}