Class AssetSymbolHelper

Hierarchy

AssetSymbolHelper

Index

Constructors

Properties

_apiVersion _symbolsDict GroupAgreement GroupConsent

Methods

addAgreement addAgreementSymbol addConsent addMetadata addMetadataSymbol extractAgreementSymbol fixLegacySymbols getLegalBasisName getSymbol hasMixedStatuses toAssetSymbolList translateV0SymbolName unifyAgreementSymbols

Constructors

constructor

new AssetSymbolHelper(apiVersion): AssetSymbolHelper
Parameters
- apiVersion: ApiVersion
Returns AssetSymbolHelper
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:17

Properties

`Private` `Readonly` _apiVersion

_apiVersion: ApiVersion

`Private` `Readonly` _symbolsDict

_symbolsDict: Map<string, AssetSymbol> = ...

`Static` `Private` `Readonly` GroupAgreement

GroupAgreement: string = "agreement"

`Static` `Private` `Readonly` GroupConsent

GroupConsent: string = "consent"

Methods

addAgreement

addAgreement(libraryItemAgreement): void
Adds an agreement
Parameters
- libraryItemAgreement: AgreementListData
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:24

addAgreementSymbol

addAgreementSymbol(agreementValidToDate, agreementIdentifier, agreementLegalBasis): void
Parameters
- agreementValidToDate: Date
- agreementIdentifier: string
- agreementLegalBasis: LegalBasis
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:42

addConsent

addConsent(consentData): void
Adds a consent user agreement data
Parameters
- consentData: ConsentUserAgreementData
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:67

addMetadata

addMetadata(metadata): void
Adds the supplied metadata as symbol
Parameters
- metadata: Metadata
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:93

addMetadataSymbol

addMetadataSymbol(metadataDefinitionSymbolKey, metadataDefinitionName, metadataValue): void
Parameters
- metadataDefinitionSymbolKey: string
- metadataDefinitionName: string
- metadataValue: string
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:98

extractAgreementSymbol

extractAgreementSymbol(status): AssetSymbol
Parameters
- status: AgreementSymbolStates
Returns AssetSymbol
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:190

fixLegacySymbols

fixLegacySymbols(): void
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:207

getLegalBasisName

getLegalBasisName(legalBasis): string
Parameters
- legalBasis: LegalBasis
Returns string
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:35

getSymbol

getSymbol(status): string
Parameters
- status: AgreementSymbolStates
Returns string
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:29

hasMixedStatuses

hasMixedStatuses(valid, validButSoonInvalid, notSet, invalid): boolean
Parameters
- valid: AssetSymbol
- validButSoonInvalid: AssetSymbol
- notSet: AssetSymbol
- invalid: AssetSymbol
Returns boolean
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:117

toAssetSymbolList

toAssetSymbolList(): AssetSymbol[]
Creates the resulting symbols list

Returns AssetSymbol[]
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:201

translateV0SymbolName

translateV0SymbolName(symbolsDictKey): string
Translates the supplied symbol name to a V0 equivalent symbol name
Parameters
- symbolsDictKey: string
Returns string
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:238

unifyAgreementSymbols

unifyAgreementSymbols(): void
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/util/AssetSymbolHelper.ts:126

Generated using TypeDoc