AgentHiveGroupsService | nice-cxone-acd-agent-apps

Service to handle Groups API calls on Agent Hive

Hierarchy

AgentHiveGroupsService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgentHiveGroupsService(): AgentHiveGroupsService

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:40
example
```
const agentHiveSvc = new AgentHiveGroupsService();
```
Returns AgentHiveGroupsService

Properties

Private auth

auth: CXoneAuth

Private baseUrl

baseUrl: string = ''

logger

logger: CcfLogger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

addMemberToGroupChat

addMemberToGroupChat(addMemberGroupChat?: AgentHiveAddMemberGroupRequest): Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:98
Method for to add members to group chat
example
```
addMemberToGroupChat(addMemberGroupChat);
```
Parameters
- Optional addMemberGroupChat: AgentHiveAddMemberGroupRequest
  
  it contains members of group and group id
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

createGroupChat

createGroupChat(groupChatRequest?: AgentHiveCreateGroupRequest): Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:53
Method to create group chat
example
```
createGroupChat(groupChatRequest);
```
Parameters
- Optional groupChatRequest: AgentHiveCreateGroupRequest
  
  it contains members of group and group name
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

getAllGroupChats

getAllGroupChats(userId: string, searchValue?: string): Promise<AssertsShape<{ groups: any; links: OptionalObjectSchema<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string>; self: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string>; self: default<string, AnyObject, string> }>> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:230
Method to get all group chat details
example
```
getAllGroupChats(userId);
```
Parameters
- userId: string
  
  user id for to get all group details
- Optional searchValue: string
Returns Promise<AssertsShape<{ groups: any; links: OptionalObjectSchema<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string>; self: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string>; self: default<string, AnyObject, string> }>> }>>

groupMemberDetails

groupMemberDetails(groupId: string): Promise<AssertsShape<{ members: any }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:272
Method to get all member details of the group
example
```
groupMemberDetails(groupId);
```
Parameters
- groupId: string
  
  group id for to get all group member details
Returns Promise<AssertsShape<{ members: any }>>

removeMemberFromGroupChat

removeMemberFromGroupChat(removeMemberGroupChat?: AgentHiveRemoveMemberGroupRequest): Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:142
Method for to remove members from group chat
example
```
removeMemberFromGroupChat(removeMemberGroupChat);
```
Parameters
- Optional removeMemberGroupChat: AgentHiveRemoveMemberGroupRequest
  
  it contains members to remove from group and group id
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

renameGroupChat

renameGroupChat(groupId: string, groupName: string): Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-groups-service.ts:186
Method for to rename group chat
example
```
renameGroupChat(renameGroupChat);
```
Parameters
- groupId: string
- groupName: string
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentHiveGroupsService

Properties

Private auth

Private baseUrl

logger

Protected utilService

Methods

addMemberToGroupChat

Parameters

Optional addMemberGroupChat: AgentHiveAddMemberGroupRequest

Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

createGroupChat

Parameters

Optional groupChatRequest: AgentHiveCreateGroupRequest

Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

getAllGroupChats

Parameters

userId: string

Optional searchValue: string

groupMemberDetails

Parameters

groupId: string

Returns Promise<AssertsShape<{ members: any }>>

removeMemberFromGroupChat

Parameters

Optional removeMemberGroupChat: AgentHiveRemoveMemberGroupRequest

Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

renameGroupChat

Parameters

groupId: string

groupName: string

Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>