Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AddressBookService

This class to expose address book services

Hierarchy

  • AddressBookService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private addressBookApiParser

addressBookApiParser: AddressBookApiParser = ...

Private auth

auth: CXoneAuth

logger

logger: Logger = ...

Private urlUtilSvc

urlUtilSvc: UrlUtilsService = ...

Protected utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Methods

getAllAddressBooks

  • This method to get all address books for selected agentId

    example
    getAllAddressBooks('23423423');

    Parameters

    • Optional agentId: string

      agent id

    • includeEntries: boolean = false

    Returns Promise<AddressBooks[] | CXoneSdkError>

getStandardEntries

  • This method to get standard address book entries

    example
    getStandardEntries('23423423');

    Parameters

    • addressBookId: string

      address book id

    • startIndex: number = 0

      starting index for address book list

    • recordsToLoad: number = 50

      number of records to load

    • searchText: string = ''

      search text for address book

    Returns Promise<AddressBookEntriesResponse | CXoneSdkError>

Generated using TypeDoc