CommitmentService | nice-cxone-acd-agent-apps

Class to manage all commitments related methods

Hierarchy

CommitmentService

Constructors

constructor

new CommitmentService(): CommitmentService

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:44
get instance for initialize commitments
example
```
new CommitmentService();
```
Returns CommitmentService

Properties

Private acdSession

acdSession: ACDSessionManager = ...

Private auth

auth: CXoneAuth

Protected logger

logger: Logger = ...

onCommitmentEvent

onCommitmentEvent: Subject<CommitmentEvent> = ...

onCommitmentStatusEvent

onCommitmentStatusEvent: Subject<CommitmentStatusEvent> = ...

onUpdateCommitments

onUpdateCommitments: Subject<unknown> = ...

Protected utilService

utilService: HttpUtilService = ...

Static Private CANCEL_COMMITMENT

CANCEL_COMMITMENT: string = '/incontactapi/services/v21.0/agent-sessions/{sessionId}/interactions/{callbackId}/cancel'

Static Private CREATE_COMMITMENT

CREATE_COMMITMENT: string = '/incontactapi/services/v25.0/scheduled-callbacks'

Static Private CREATE_COMMITMENT_TS

CREATE_COMMITMENT_TS: string = '/incontactapi/services/v33.0/scheduled-callbacks'

Static Private DELETE_COMMITMENT

DELETE_COMMITMENT: string = '/incontactapi/services/v25.0/scheduled-callbacks/{callbackId}'

Static Private EDIT_COMMITMENT

EDIT_COMMITMENT: string = '/incontactapi/services/v25.0/scheduled-callbacks/{callbackId}'

Static Private EDIT_COMMITMENT_TS

EDIT_COMMITMENT_TS: string = '/incontactapi/services/v33.0/scheduled-callbacks/{callbackId}'

Static Private GET_COMMITMENTS

GET_COMMITMENTS: string = '/incontactapi/services/v25.0/agents/{agentId}/scheduled-callbacks'

Static Private MAKE_COMMITMENT_CALL

MAKE_COMMITMENT_CALL: string = '/incontactapi/services/v21.0/agent-sessions/{sessionId}/interactions/{callbackId}/dial'

Static Private RESCHEDULE_COMMITMENT

RESCHEDULE_COMMITMENT: string = '/incontactapi/services/v21.0/agent-sessions/{sessionId}/interactions/{callbackId}/reschedule'

Methods

cancelCommitment

cancelCommitment(callbackId: number, notes?: string): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:188
This method is to cancel commitment which is shown in assignment app
example
```
cancelCommitment(callbackId);
```
Parameters
- callbackId: number
  
  callbackId of commitment
- notes: string = ''
Returns Promise<HttpResponse>

createCommitment

createCommitment(commitmentRequest: CommitmentRequest): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:220
This method is to create commitment for schedule app
example
```
createCommitment(commitmentDetail);
```
Parameters
- commitmentRequest: CommitmentRequest
  
  commitment details
Returns Promise<HttpResponse>

deleteCommitment

deleteCommitment(callbackId: number, description?: string): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:291
This method is to delete commitment for schedule app
example
```
deleteCommitment(1073743450);
```
Parameters
- callbackId: number
  
  unique callback id
- description: string = ''
Returns Promise<HttpResponse>

editCommitment

editCommitment(callbackId: number, commitmentRequest: CommitmentRequest): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:256
This method is to edit commitment for schedule app
example
```
editCommitment(1073743450, commitmentDetail);
```
Parameters
- callbackId: number
  
  unique id of callback
- commitmentRequest: CommitmentRequest
  
  commitment details
Returns Promise<HttpResponse>

getCommitments

getCommitments(agentId: number): Promise<CommitmentResponse[]>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:99
This method is to get all the commitments
example
```
getCommitments(1464319);
```
Parameters
- agentId: number
  
  unique id of agent
Returns Promise<CommitmentResponse[]>

makeCommitmentCall

makeCommitmentCall(callbackId: number): Promise<unknown>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:129
This method is to make a call on receive commitment
example
```
makeCommitmentCall(callbackId);
```
Parameters
- callbackId: number
  
  callbackId of commitment
Returns Promise<unknown>

Private promiseKeeper

promiseKeeper(callDetails: CommitmentEvent): void

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:76
Method to get PromiseKeeper event
```
@example
this.promiseKeeper(callDetails);
```
Parameters
- callDetails: CommitmentEvent
Returns void

Private promiseKeeperStatus

promiseKeeperStatus(status: CommitmentStatusEvent): void

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:87
Method to get PromiseKeeperStatus event and emit commitment reschedule event
```
@example
this.promiseKeeperStatus(status);
```
Parameters
- status: CommitmentStatusEvent
Returns void

rescheduleCommitment

rescheduleCommitment(callbackId: number, rescheduleDate: string): Promise<unknown>

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:158
This method is to reschedule commitment for schedule app
example
```
rescheduleCommitment(callbackId, rescheduleDate);
```
Parameters
- callbackId: number
  
  callbackId of commitment
- rescheduleDate: string
  
  date for reschedule commitment
Returns Promise<unknown>

Private updateCommitments

updateCommitments(): void

- Defined in agent-sdk/src/lib/commitment/commitment-service.ts:65
Method to update commitments
```
@example
this.updateCommitments();
```
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CommitmentService

Properties

Private acdSession

Private auth

Protected logger

onCommitmentEvent

onCommitmentStatusEvent

onUpdateCommitments

Protected utilService

Static Private CANCEL_COMMITMENT

Static Private CREATE_COMMITMENT

Static Private CREATE_COMMITMENT_TS

Static Private DELETE_COMMITMENT

Static Private EDIT_COMMITMENT

Static Private EDIT_COMMITMENT_TS

Static Private GET_COMMITMENTS

Static Private MAKE_COMMITMENT_CALL

Static Private RESCHEDULE_COMMITMENT

Methods

cancelCommitment

Parameters

callbackId: number

notes: string = ''

Returns Promise<HttpResponse>

createCommitment

Parameters

commitmentRequest: CommitmentRequest

Returns Promise<HttpResponse>

deleteCommitment

Parameters

callbackId: number

description: string = ''

Returns Promise<HttpResponse>

editCommitment

Parameters

callbackId: number

commitmentRequest: CommitmentRequest

Returns Promise<HttpResponse>

getCommitments

Parameters

agentId: number

Returns Promise<CommitmentResponse[]>

makeCommitmentCall

Parameters

callbackId: number

Returns Promise<unknown>

Private promiseKeeper

Parameters

callDetails: CommitmentEvent

Returns void

Private promiseKeeperStatus

Parameters

status: CommitmentStatusEvent

Returns void

rescheduleCommitment

Parameters

callbackId: number

rescheduleDate: string

Returns Promise<unknown>

Private updateCommitments

Returns void