AgentHiveFavoritesService | nice-cxone-acd-agent-apps

Service to handle Favorites API calls on Agent Hive

Hierarchy

AgentHiveFavoritesService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgentHiveFavoritesService(): AgentHiveFavoritesService

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

Properties

Private auth

auth: CXoneAuth

Private baseUrl

baseUrl: string = ''

logger

logger: CcfLogger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

getAllFavorites

getAllFavorites(userId: string): Promise<AssertsShape<{ members: any }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-favorites-service.ts:87
Method to get all favorite members
example
```
getAllFavorites(userId);
```
Parameters
- userId: string
  
  it contains user id for to get favorite member
Returns Promise<AssertsShape<{ members: any }>>

markUserAsFavorite

markUserAsFavorite(userId: string, memberId: string): Promise<AssertsShape<{ responseMessage: default<string, AnyObject, string>; returnCode: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-favorites-service.ts:126
Method to add users in favorite list
example
```
markUserAsFavorite(userId, memberId);
```
Parameters
- userId: string
  
  it contains user id for to get favorite member
- memberId: string
  
  it contains user id for to add favorite member
Returns Promise<AssertsShape<{ responseMessage: default<string, AnyObject, string>; returnCode: default<string, AnyObject, string> }>>

removeFavoriteMember

removeFavoriteMember(removeFavRequest?: AgentHiveRemoveFavoriteRequest): Promise<AssertsShape<{ responseMessage: default<string, AnyObject, string>; returnCode: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-favorites-service.ts:46
Method to remove a member from favorite
example
```
removeFavoriteMember(removeFavRequest);
```
Parameters
- Optional removeFavRequest: AgentHiveRemoveFavoriteRequest
  
  it contains user id of the user
Returns Promise<AssertsShape<{ responseMessage: default<string, AnyObject, string>; returnCode: default<string, AnyObject, string> }>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentHiveFavoritesService

Properties

Private auth

Private baseUrl

logger

Protected utilService

Methods

getAllFavorites

Parameters

userId: string

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

markUserAsFavorite

Parameters

userId: string

memberId: string

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

removeFavoriteMember

Parameters

Optional removeFavRequest: AgentHiveRemoveFavoriteRequest

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