Class AddressBookService

This class to expose address book services

Hierarchy

AddressBookService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AddressBookService(): AddressBookService

- Defined in agent-sdk/src/lib/directory/service/address-book-service.ts:30
```
@example
const adminService = new AdminService();
```
Returns AddressBookService

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

getAllAddressBooks(agentId?: string, includeEntries?: boolean): Promise<AddressBooks[] | CXoneSdkError>

- Defined in agent-sdk/src/lib/directory/service/address-book-service.ts:42
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

getStandardEntries(addressBookId: string, startIndex?: number, recordsToLoad?: number, searchText?: string): Promise<AddressBookEntriesResponse | CXoneSdkError>

- Defined in agent-sdk/src/lib/directory/service/address-book-service.ts:176
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