Interface SearchDirectoriesRequest

Interface for dynamic directory search request

Hierarchy

SearchDirectoriesRequest

Index

Properties

Properties

Optional directoryUUID

directoryUUID?: string

remarks

directory id passed if search is required on a specific directory(optional)

Optional fieldType

fieldType?: string[]

remarks

Field type on which search result is filterd(to be passed with partner type)

Optional partnerType

partnerType?: string[]

remarks

Partner type on which search result is filterd(to be passed with field type)

Optional realTimeUpdates

realTimeUpdates?: boolean

remarks

passed as true if real time update is required over websocket else false if only one time result is required(required)(default - false).

Optional searchString

searchString?: string

remarks

This is first name, last name or email to be searched(required)

Optional skip

skip?: number

remarks

Number of records to be skipped for current pagination(required)

Optional subscriptionId

subscriptionId?: string

remarks

subscription id to request(optional)

Optional top

top?: number

remarks

Number of records to be fetched current pagination(required)

Generated using TypeDoc