Class DefaultClient

Hierarchy

DefaultClient

Implements

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DefaultClient(url: string, options?: ApiOptions): DefaultClient

- Defined in client.ts:23
Parameters
- url: string
- Optional options: ApiOptions
Returns DefaultClient

Properties

api

api: Api

resolvedApi

resolvedApi: ResolvedApi

Methods

everything

everything(): LazySearchForm

- Defined in client.ts:33
Returns LazySearchForm

form

form(formId: string): LazySearchForm

- Defined in client.ts:37
Parameters
- formId: string
Returns LazySearchForm

getApi

getApi(): Promise<ResolvedApi>

- Defined in client.ts:29
Returns Promise<ResolvedApi>

getBookmark

getBookmark(bookmark: string, options: QueryOptions, cb?: RequestCallback<Document>): Promise<Document>

Implementation of Client.getBookmark
- Defined in client.ts:65
Parameters
- bookmark: string
- options: QueryOptions
- Optional cb: RequestCallback<Document>
Returns Promise<Document>

getByID

getByID(id: string, options: QueryOptions, cb?: RequestCallback<Document>): Promise<Document>

Implementation of Client.getByID
- Defined in client.ts:49
Parameters
- id: string
- options: QueryOptions
- Optional cb: RequestCallback<Document>
Returns Promise<Document>

getByIDs

getByIDs(ids: string[], options: QueryOptions, cb?: RequestCallback<ApiSearchResponse>): Promise<ApiSearchResponse>

Implementation of Client.getByIDs
- Defined in client.ts:53
Parameters
- ids: string[]
- options: QueryOptions
- Optional cb: RequestCallback<ApiSearchResponse>
Returns Promise<ApiSearchResponse>

getByUID

getByUID(type: string, uid: string, options: QueryOptions, cb?: RequestCallback<Document>): Promise<Document>

Implementation of Client.getByUID
- Defined in client.ts:57
Parameters
- type: string
- uid: string
- options: QueryOptions
- Optional cb: RequestCallback<Document>
Returns Promise<Document>

getSingle

getSingle(type: string, options: QueryOptions, cb?: RequestCallback<Document>): Promise<Document>

Implementation of Client.getSingle
- Defined in client.ts:61
Parameters
- type: string
- options: QueryOptions
- Optional cb: RequestCallback<Document>
Returns Promise<Document>

previewSession

previewSession(token: string, linkResolver: function, defaultUrl: string, cb?: RequestCallback<string>): Promise<string>

- Defined in client.ts:69
Parameters
- token: string
- linkResolver: function
  - - (doc: any): string
    - Parameters
      - doc: any
      Returns string
- defaultUrl: string
- Optional cb: RequestCallback<string>
Returns Promise<string>

query

query(q: string | string[], optionsOrCallback: QueryOptions | RequestCallback<ApiSearchResponse>, cb?: RequestCallback<ApiSearchResponse>): Promise<ApiSearchResponse>

Implementation of Client.query
- Defined in client.ts:41
Parameters
- q: string | string[]
- optionsOrCallback: QueryOptions | RequestCallback<ApiSearchResponse>
- Optional cb: RequestCallback<ApiSearchResponse>
Returns Promise<ApiSearchResponse>

queryFirst

queryFirst(q: string | string[], optionsOrCallback: QueryOptions | RequestCallback<Document>, cb?: RequestCallback<Document>): Promise<Document>

Implementation of Client.queryFirst
- Defined in client.ts:45
Parameters
- q: string | string[]
- optionsOrCallback: QueryOptions | RequestCallback<Document>
- Optional cb: RequestCallback<Document>
Returns Promise<Document>

Static getApi

getApi(url: string, options?: ApiOptions): Promise<ResolvedApi>

- Defined in client.ts:73
Parameters
- url: string
- Optional options: ApiOptions
Returns Promise<ResolvedApi>

Generated using TypeDoc