Reference of Group
Description of Group
PTTClient PTTChannel VideoChannel FileChannelGroup Class
| name | type | attributes | description |
|---|---|---|---|
| groupID | int | readonly | Group ID |
| groupName | string | readonly | Group name |
| Methods |
|---|
| Events |
|---|
Methods
addBuddy
| int addBuddy(string UserID) | |
| UserID | User ID to be added. |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | PTTClient::OnBuddyRequested() |
| Description | Request to add |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
acceptBuddy
| int acceptBuddy(string RequesterID, boolean isAdd) | |
| RequesterID | Requester's ID |
|---|---|
| isAdd | Whether to add Requester |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onBuddyAccepted() |
| Description | Accept to add |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
denyBuddy
| int denyBuddy(string RequesterID) | |
| RequesterID | Requester's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onBuddyDenied() |
| Description | Deny to add |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
deleteBuddy
| int deleteBuddy(string UserID) | |
| UserID | User ID to be deleted. |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onBuddyDeleted() |
| Description | Request to delete |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
Events
onBuddyError
| void onBuddyError(Group GroupInstance, int ErrorCode, string ErrorMesssage) | |
| ErrorCode | Error code. see Main 6 |
|---|---|
| ErrorMesssage | Error message |
| Description | Errer event |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
onBuddyResult
| void onBuddyResult(Group GroupInstance, int Seq, ResultCode, string ResultMesssage) | |
| Seq | Requested Sequence ID |
|---|---|
| ResultCode | Error code. see Main 7 |
| ResultMesssage | Error message |
| Description | Errer event for request |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
onBuddyAdded
| void onBuddyAdded(Group GroupInstance, string UserID) | |
| UserID | Added user ID |
|---|---|
| Description | Response of AddBuddy, iOS and Android add it after addBuddy call. |
| Android SDK | Not supported |
| iOS SDK | Not supported |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |
onBuddyDeleted
| void onBuddyDeleted(Group GroupInstance, string UserID) | |
| UserID | Deleted user ID |
|---|---|
| Description | Response of DeleteBuddy |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | 3.0.1 |