Interface Client

Hierarchy

Client

Implemented by

Index

Methods

Methods

getBookmark

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

- Defined in client.ts:16
Parameters
- bookmark: string
- options: QueryOptions
- cb: RequestCallback<Document>
Returns Promise<Document>

getByID

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

- Defined in client.ts:12
Parameters
- id: string
- options: QueryOptions
- cb: RequestCallback<Document>
Returns Promise<Document>

getByIDs

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

- Defined in client.ts:13
Parameters
- ids: string[]
- options: QueryOptions
- cb: RequestCallback<ApiSearchResponse>
Returns Promise<ApiSearchResponse>

getByUID

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

- Defined in client.ts:14
Parameters
- type: string
- uid: string
- options: QueryOptions
- cb: RequestCallback<Document>
Returns Promise<Document>

getSingle

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

- Defined in client.ts:15
Parameters
- type: string
- options: QueryOptions
- cb: RequestCallback<Document>
Returns Promise<Document>

previewSession

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

- Defined in client.ts:17
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>

- Defined in client.ts:10
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>

- Defined in client.ts:11
Parameters
- q: string | string[]
- optionsOrCallback: QueryOptions | RequestCallback<Document>
- cb: RequestCallback<Document>
Returns Promise<Document>

Generated using TypeDoc