Jump to Content

ArtifactClient | @here/olp-sdk-ts

ArtifactClient | @here/olp-sdk-ts

Class ArtifactClient

Gets schema metadata and data from the platform Artifact Service.

Hierarchy

ArtifactClient

Index

Constructors

constructor

Methods

Constructors

constructor

new ArtifactClient(settings: OlpClientSettings): ArtifactClient

- Defined in @here/olp-sdk-dataservice-read/lib/client/ArtifactClient.ts:39
Constructs a new client to work with schemas data in the platform Artifact Service.

Parameters
- settings: OlpClientSettings
  
  The OlpClientSettings instance.
Returns ArtifactClient
The ArtifactClient instance.

Methods

getSchema

getSchema(schemaRequest: SchemaRequest): Promise<ArrayBuffer>

- Defined in @here/olp-sdk-dataservice-read/lib/client/ArtifactClient.ts:78
Gets schema data.

Parameters
- schemaRequest: SchemaRequest
  
  The SchemaRequest instance.
Returns Promise<ArrayBuffer>
A blob with the schema.

getSchemaDetails

getSchemaDetails(schemaDetailsRequest: SchemaDetailsRequest): Promise<GetSchemaResponseObj>

- Defined in @here/olp-sdk-dataservice-read/lib/client/ArtifactClient.ts:47
Gets schema metadata.

Parameters
- schemaDetailsRequest: SchemaDetailsRequest
  
  The SchemaDetailsRequest instance.
Returns Promise<GetSchemaResponseObj>
An object with the schema metadata.

Generated using TypeDoc