Class default

API implements the service interface and is the concrete implementation of the api end point.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/annotations/AnnotationsV2.ts:75

Properties

NAME

NAME: string = "Annotations"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Annotations"

`Static` VERSION

VERSION: number = 2

Methods

get

get(params: Entities): Promise<AnnotationsGetResults>
Get returns annotations for given entities. If annotations cannot be retrieved for a given entity, an error is returned. Each entity is treated independently and, hence, will fail or succeed independently.
Parameters
- params: Entities
Returns Promise<AnnotationsGetResults>
- Defined in api/facades/annotations/AnnotationsV2.ts:87

set

set(params: AnnotationsSet): Promise<ErrorResults>
Set stores annotations for given entities
Parameters
- params: AnnotationsSet
Returns Promise<ErrorResults>
- Defined in api/facades/annotations/AnnotationsV2.ts:103

Generated using TypeDoc