Class: MappingsApiProvider

Constructor

new MappingsApiProvider()

Source: providers/mappings-api-provider.js, line 33

Extends

BaseProvider

Members

(readonly) has :Object

A dictionary with functionality of the registry (e.g. registry.has.schemes).

Type:

Object

Inherited From: BaseProvider#has
Source: providers/base-provider.js, line 93

languages :Array.<string>

A list of RFC 3066 language tags in lowercase in order of priority.

Type:

Array.<string>

Inherited From: BaseProvider#languages
Source: providers/base-provider.js, line 100

Methods

(async) deleteAnnotation(config) → {boolean}

Deletes an annotation.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`annotation`	Object	JSKOS annotation

Source: providers/mappings-api-provider.js, line 388

Returns:

true if deletion was successful

Type:: boolean

(async) deleteConcordance(config) → {boolean}

Deletes a concordance.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concordance`	Object	JSKOS concordance

Source: providers/mappings-api-provider.js, line 499

Returns:

true if deletion was successful

Type:: boolean

(async) deleteMapping(config) → {boolean}

Deletes a mapping.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mapping`	Object	JSKOS mapping

Source: providers/mappings-api-provider.js, line 291

Returns:

true if deletion was successful

Type:: boolean

(async) deleteMappings(config) → {Array.<Object>}

DELETEs multiple mappings. Do not override in subclass!

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mappings`	Array	array of mapping objects

Inherited From: BaseProvider#deleteMappings
Source: providers/base-provider.js, line 621

Returns:

array of results (true if successful); in case of failure, consult the _errors property on the array at the index of the failed request

Type:: Array.<Object>

(async) getAnnotations(config) → {Array.<Object>}

Returns a list of annotations.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`target`	string	<optional>	target URI

Source: providers/mappings-api-provider.js, line 314

Returns:

array of JSKOS annotation objects

Type:: Array.<Object>

getCancelTokenSource() → {Object}

Returns a source for a axios cancel token.

Inherited From: BaseProvider#getCancelTokenSource
Source: providers/base-provider.js, line 392

Returns:

axios cancel token source

Type:: Object

(async) getConcordances(config) → {Array.<Object>}

Returns a list of concordances.

Parameters:

Name	Type	Description
`config`	Object

Source: providers/mappings-api-provider.js, line 407

Returns:

array of JSKOS concordance objects

Type:: Array.<Object>

(async) getMapping(config) → {Object}

Returns a single mapping.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mapping`	Object	JSKOS mapping

Source: providers/mappings-api-provider.js, line 105

Returns:

JSKOS mapping object

Type:: Object

(async) getMappings(config) → {Array.<Object>}

Returns a list of mappings.

Parameters:

Name	Type	Description
`config`	Object	request config with parameters

Source: providers/mappings-api-provider.js, line 135

Returns:

array of JSKOS mapping objects

Type:: Array.<Object>

(async) init() → {Promise}

Load data about registry via the status endpoint.

Inherited From: BaseProvider#init
Source: providers/base-provider.js, line 329

Returns:

Promise that resolves when initialization is complete.

Type:: Promise

isAuthorizedFor(options) → {boolean}

Returns whether a user is authorized for a certain request.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Description
`type`	string		type of item (e.g. mappings)
`action`	string		action to be performed (read/create/update/delete)
`user`	Object		user object
`crossUser`	boolean	<optional>	whether the request is a crossUser request (i.e. updading/deleting another user's item)

Inherited From: BaseProvider#isAuthorizedFor
Source: providers/base-provider.js, line 438

Returns:

Type:: boolean

(async) patchAnnotation(config) → {Object}

Patches an annotation.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`annotation`	Object	JSKOS annotation

Source: providers/mappings-api-provider.js, line 368

Returns:

JSKOS annotation object

Type:: Object

(async) patchConcordance(config) → {Object}

Patches a concordance.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concordance`	Object	JSKOS concordance (or part of concordance)

Source: providers/mappings-api-provider.js, line 472

Returns:

JSKOS concordance object

Type:: Object

(async) patchMapping(config) → {Object}

Patches a mapping.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mapping`	Object	JSKOS mapping (or part of mapping)

Source: providers/mappings-api-provider.js, line 264

Returns:

JSKOS mapping object

Type:: Object

(async) postAnnotation(config) → {Object}

Creates an annotation.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`annotation`	Object	JSKOS annotation

Source: providers/mappings-api-provider.js, line 332

Returns:

JSKOS annotation object

Type:: Object

(async) postConcordance(config) → {Object}

Creates a concordance.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concordance`	Object	JSKOS concordance

Source: providers/mappings-api-provider.js, line 422

Returns:

JSKOS concordance object

Type:: Object

(async) postMapping(config) → {Object}

Creates a mapping.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mapping`	Object	JSKOS mapping

Source: providers/mappings-api-provider.js, line 210

Returns:

JSKOS mapping object

Type:: Object

(async) postMappings(config) → {Array.<Object>}

POSTs multiple mappings. Do not override in subclass!

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mappings`	Array	array of mapping objects

Inherited From: BaseProvider#postMappings
Source: providers/base-provider.js, line 602

Returns:

array of created mapping objects; in case of failure, consult the _errors property on the array at the index of the failed request

Type:: Array.<Object>

(async) putAnnotation(config) → {Object}

Overwrites an annotation.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`annotation`	Object	JSKOS annotation

Source: providers/mappings-api-provider.js, line 348

Returns:

JSKOS annotation object

Type:: Object

(async) putConcordance(config) → {Object}

Overwrites a concordance.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concordance`	Object	JSKOS concordance

Source: providers/mappings-api-provider.js, line 445

Returns:

JSKOS concordance object

Type:: Object

(async) putMapping(config) → {Object}

Overwrites a mapping.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mapping`	Object	JSKOS mapping

Source: providers/mappings-api-provider.js, line 235

Returns:

JSKOS mapping object

Type:: Object

setAuth(options)

Sets authentication credentials.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`key`	string	public key of login-server instance the user is authorized for
`bearerToken`	string	token that is sent with each request

Inherited From: BaseProvider#setAuth
Source: providers/base-provider.js, line 403

setRetryConfig(config)

Sets retry configuration.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`methods`	Array.<string>	<optional>	["get", "head", "options"]	HTTP methods to retry (lowercase)
`statusCodes`	Array.<number>	<optional>	[401, 403]	status codes to retry
`count`	number	<optional>	3	maximum number of retries
`delay`	number \| function	<optional>	300*count	a delay in ms or a function that takes the number of current retries and returns a delay in ms

Inherited From: BaseProvider#setRetryConfig
Source: providers/base-provider.js, line 417

supportsScheme(scheme) → {boolean}

Returns a boolean whether a certain target scheme is supported or not.

Parameters:

Name	Type	Description
`scheme`	Object

Inherited From: BaseProvider#supportsScheme
Source: providers/base-provider.js, line 483

Returns:

Type:: boolean