AgentHiveUsersService | nice-cxone-acd-agent-apps

Service to handle Users API calls on Agent Hive

Hierarchy

AgentHiveUsersService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgentHiveUsersService(): AgentHiveUsersService

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

Properties

Private auth

auth: CXoneAuth

Private baseUrl

baseUrl: string = ''

logger

logger: CcfLogger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

downloadAllAttachment

downloadAllAttachment(attachmentIds: string[]): Promise<HttpResponse>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-users-service.ts:241
Get all attachment for digital contact
example
```
downloadAllAttachment(['5846adee-70de-4463-9755-ef23d006b67d','3fc84c90-3301-11ef-a1bf-c739f8d018c2'])
```
Parameters
- attachmentIds: string[]
  
  list of attachment ids
Returns Promise<HttpResponse>
- blob response of file

getAllUsers

getAllUsers(value?: string): Promise<AssertsShape<{ totalUsers: RequiredNumberSchema<number, AnyObject>; users: any }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-users-service.ts:50
Method to get all users list
example
```
getAllUsers(userRequest);
```
Parameters
- Optional value: string
Returns Promise<AssertsShape<{ totalUsers: RequiredNumberSchema<number, AnyObject>; users: any }>>

initUserHubSync

initUserHubSync(userId: string): Promise<unknown>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-users-service.ts:185
Method to initialize UserHub Sync
example
```
initUserHubSync(userId);
```
Parameters
- userId: string
  
  The ID of the user to sync
Returns Promise<unknown>

updateUserAvailability

updateUserAvailability(userAvailability: AgentHiveUserAvailabilityRequest): 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-users-service.ts:94
Method for to update user availability
example
```
updateUserAvailability(userAvailability);
```
Parameters
- userAvailability: AgentHiveUserAvailabilityRequest
  
  it contains id and userstate for the user
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

updateUserSubscription

updateUserSubscription(userSubscriptionPayload: AgentHiveUserSubscriptionRequest): 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-users-service.ts:138
Method for to update user subscription
example
```
updateUserSubscription(userSubscriptionPayload);
```
Parameters
- userSubscriptionPayload: AgentHiveUserSubscriptionRequest
  
  it contains id and members for the user
Returns Promise<AssertsShape<{ errorCode: default<string, AnyObject, string>; responseMessage: RequiredStringSchema<string, AnyObject>; returnCode: RequiredStringSchema<string, AnyObject> }>>

upload

upload(uploadDetails: CXoneFileUploadRequest, uId: string): Promise<AssertsShape<{ expireAt: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; uId: RequiredStringSchema<string, AnyObject>; url: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-users-service.ts:273
Upload file attachment for conversation
example
```
upload(uploadDetails, 'unique-id-123')
```
Parameters
- uploadDetails: CXoneFileUploadRequest
  
  file upload request details
- uId: string
  
  unique identifier for the upload
Returns Promise<AssertsShape<{ expireAt: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; uId: RequiredStringSchema<string, AnyObject>; url: RequiredStringSchema<string, AnyObject> }>>
- Promise resolving to file upload response

uploadConversationAttachment

uploadConversationAttachment(uploadDetails: CXoneFileUploadRequest): Promise<HttpResponse>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-users-service.ts:209
Method to upload attachment to s3 bucket for digital contact
example
Parameters
- uploadDetails: CXoneFileUploadRequest
Returns Promise<HttpResponse>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentHiveUsersService

Properties

Private auth

Private baseUrl

logger

Protected utilService

Methods

downloadAllAttachment

Parameters

attachmentIds: string[]

Returns Promise<HttpResponse>

getAllUsers

Parameters

Optional value: string

Returns Promise<AssertsShape<{ totalUsers: RequiredNumberSchema<number, AnyObject>; users: any }>>

initUserHubSync

Parameters

userId: string

Returns Promise<unknown>

updateUserAvailability

Parameters

userAvailability: AgentHiveUserAvailabilityRequest

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

updateUserSubscription

Parameters

userSubscriptionPayload: AgentHiveUserSubscriptionRequest

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

upload

Parameters

uploadDetails: CXoneFileUploadRequest

uId: string

Returns Promise<AssertsShape<{ expireAt: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; uId: RequiredStringSchema<string, AnyObject>; url: RequiredStringSchema<string, AnyObject> }>>

uploadConversationAttachment

Parameters

uploadDetails: CXoneFileUploadRequest

Returns Promise<HttpResponse>