Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the base class for Dynamic Directory

Hierarchy

  • CXoneDynamicDirectory

Index

Constructors

Properties

auth: CXoneAuth
currentNewGenSearchDirectoriesRequest?: SearchDirectoriesRequest
currentSearchDirectoriesRequest: SearchDirectoriesRequest = {}
directory: string = 'Directory'
isPendingNewGenUnsubscribe: boolean = false
logger: Logger = ...
messageReceivedSubscription?: Subscription
newGenMessageReceivedSubscription?: Subscription
newGenWsProvider: WSProvider = ...
onMessageReceived: Subject<DynamicDirectoyMessage> = ...
onNewGenMessageReceived: Subject<DynamicDirectoyMessage> = ...
pendingNewGenSubscriptionId?: string
searchDirectoriesResponse: SearchDirectoriesResponse = ...
searchDirectoryResult: Subject<unknown> = ...
searchNewGenDirectoriesResponse: SearchDirectoriesResponse = ...
searchNewGenDirectoryResult: Subject<unknown> = ...
urlUtilsService: UrlUtilsService = ...
utilService: HttpUtilService = ...
validationUtils: ValidationUtils = ...
wsProvider: WSProvider = ...

Methods

  • endDirectoriesSearch(subscriptionId: string): void
  • Method used to get all directory entries

    Parameters

    • directoryId: string

      Directory id for which we need to get metadata

    • agentId: string

      Agent id for which directories are fetched

    • startIndex: number = 0

      start index for pagination

    • totalRecords: number = 25

      total records to be fetched

    Returns Promise<CXoneSdkError | DirectoryEntries>

    • return the directory entries list
    @example
    getDirectoryEntries('11eb3f87', '1124893d', 0, 25)
  • Method used to get new gen directories

    Parameters

    • agentId: string

      Agent id for which directories are fetched

    • startIndex: number = 0

      start index for pagination

    • totalRecords: number = 25

      total records to be fetched

    Returns Promise<CXoneSdkError | Directories>

    • return the list of new gen directories
    @example
    getNewGenDirectories(1234,0,25)
    This will get new gen directories from 0 to 25 for agent id 1234
  • setDomVisibility(domVisibility: boolean): void
  • setSelectedTabs(appSpaceSelectedTab: string, globalSelectedTab: string): void
  • socketMessageHandler(provider: WSProvider, isNewGen: boolean): void
  • updateFavExtDirEntriesFromClientData(): Promise<void>
  • updateFavNewGenDirEntriesFromClientData(): Promise<void>

Generated using TypeDoc