Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommitmentService

Class to manage all commitments related methods

Hierarchy

  • CommitmentService

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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 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 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>

  • 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

  • This method is to create commitment for schedule app

    example
    createCommitment(commitmentDetail);

    Parameters

    Returns Promise<HttpResponse>

deleteCommitment

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

  • This method is to delete commitment for schedule app

    example
    deleteCommitment(1073743450);

    Parameters

    • callbackId: number

      unique callback id

    • description: string = ''

    Returns Promise<HttpResponse>

editCommitment

  • 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

  • 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>

  • This method is to make a call on receive commitment

    example
    makeCommitmentCall(callbackId);

    Parameters

    • callbackId: number

      callbackId of commitment

    Returns Promise<unknown>

Private promiseKeeper

  • Method to get PromiseKeeper event

    @example
    this.promiseKeeper(callDetails);

    Parameters

    Returns void

Private promiseKeeperStatus

  • Method to get PromiseKeeperStatus event and emit commitment reschedule event

    @example
    this.promiseKeeperStatus(status);

    Parameters

    Returns void

rescheduleCommitment

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

  • 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

  • Method to update commitments

    @example
    this.updateCommitments();

    Returns void

Generated using TypeDoc