Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneDynamicDirectory

This is the base class for Dynamic Directory

Hierarchy

  • CXoneDynamicDirectory

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create instance for dynamic directory session and initialize it

    example
    new CXoneDynamicDirectory();

    Returns CXoneDynamicDirectory

Properties

Private auth

auth: CXoneAuth

Private currentSearchDirectoriesRequest

currentSearchDirectoriesRequest: SearchDirectoriesRequest = {}

Private directory

directory: string = 'Directory'

Protected logger

logger: Logger = ...

Private messageReceivedSubscription

messageReceivedSubscription: any

onMessageReceived

onMessageReceived: Subject<DynamicDirectoyMessage> = ...

Private searchDirectoriesResponse

searchDirectoriesResponse: SearchDirectoriesResponse = ...

searchDirectoryResult

searchDirectoryResult: Subject<unknown> = ...

Private urlUtilsService

urlUtilsService: UrlUtilsService = ...

Private utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Private wsProvider

wsProvider: WSProvider = ...

Methods

endDirectoriesSearch

  • endDirectoriesSearch(subscriptionId: string): void

  • Method used to end WebSocket dynamic directory serach

    example
    this.endDirectoriesSearch();

    Parameters

    • subscriptionId: string

    Returns void

getDirectories

  • Method used to get 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 directories
    @example
    getDirectories(1234,0,25)
    This will get directories from 0 to 25 for agent id 1234

getDirectoryEntries

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

getDirectoryMetadata

  • Method used to get Directory metadata

    example
    getDirectoryMetadata(5678, 1234);

    This will get directory metadata for agent id 1234 and directory id 5678

    Parameters

    • directoryId: string

      Directory id for which we need to get metadata

    • agentId: string

      Agent id for which directories are fetched

    Returns Promise<CXoneSdkError | DirectoryMetadata>

    • return the directory metadata

Private mergeSearchResults

publishFinalDynamicDirectoryResponse

  • Method used to update subject with directory search response

    example
    this.publishFinalDynamicDirectoryResponse();

    Parameters

    Returns void

searchDirectories

  • Method is used to serach directories

    Parameters

    Returns void

    • return object of type SearchDirectoriesResponse. Containing filtered directories based on search parameter
    @example --
    const searchDirectoriesRequest:SearchDirectoriesRequest = \{
    \{
    "subscriptionId": "subscriptionId",
    "searchString": "firstname lastname",
    "realTimeUpdates": true/false,
    "skip": 0,
    "top": 50,
    "directoryUUID": "directoryUUID"
    "filter": \{
       "partnerType": [
        "Zoom"
     ],
      "fieldType": [
           "email"
        ]
    \}
    \}
    \}

setDomVisibility

  • setDomVisibility(domVisibility: boolean): void

  • Use set the dom visibility

    example
    this.setDomVisibility();

    Parameters

    • domVisibility: boolean

    Returns void

setSelectedTabs

  • setSelectedTabs(appSpaceSelectedTab: string, globalSelectedTab: string): void

  • Use get the selected tab

    example
    this.setSelectedTabs();

    Parameters

    • appSpaceSelectedTab: string
    • globalSelectedTab: string

    Returns void

Private socketMessageHandler

  • socketMessageHandler(): void

  • Method used to connect the WebSocket

    example
    this.connectSocket();

    Returns void

Generated using TypeDoc