Class TextExtractionsPager

TextExtractionsPager can be used to simplify the use of listTextExtractions().

Hierarchy (view full)

Pager<WatsonXAI.TextExtractionResource, WatsonXAI.ListTextExtractionsParams>
- TextExtractionsPager

Index

Constructors

Properties

client hasNextPage pageContext params

Methods

getAll getNext hasNext

Constructors

constructor

new TextExtractionsPager(client, params?): WatsonXAI.TextExtractionsPager
Construct a TextExtractionsPager object.
Parameters
- client: WatsonXAI
  The service client instance used to invoke listTextExtractions()
- Optional params: WatsonXAI.ListTextExtractionsParams
  The parameters to be passed to listTextExtractions()
Returns WatsonXAI.TextExtractionsPager
Overrides Pager.constructor
- Defined in vml_v1.ts:7258

Properties

`Protected` client

client: WatsonXAI

`Protected` hasNextPage

hasNextPage: boolean

`Protected` pageContext

pageContext: {
next: undefined | string;
}

Type declaration

next: undefined | string

`Protected` params

params: WatsonXAI.ListTextExtractionsParams

Methods

getAll

getAll(): Promise<WatsonXAI.TextExtractionResource[]>
Returns all results by repeatedly invoking getNext() until all pages of results have been retrieved.

Returns Promise<WatsonXAI.TextExtractionResource[]>
A Promise that resolves to an array of all resources
Inherited from Pager.getAll
- Defined in vml_v1.ts:7141

getNext

getNext(): Promise<WatsonXAI.TextExtractionResource[]>
Returns the next page of results by invoking listTextExtractions().

Returns Promise<WatsonXAI.TextExtractionResource[]>
A Promise that resolves to an array of text extraction resources
Overrides Pager.getNext
- Defined in vml_v1.ts:7268

hasNext

hasNext(): boolean
Returns true if there are potentially more results to be retrieved by invoking getNext().

Returns boolean
True if there are more results available, false otherwise
Inherited from Pager.hasNext
- Defined in vml_v1.ts:7121