Reference / Modules / client / LogionClassification

Class: LogionClassification

client.LogionClassification

Provides a Logion Classification.

Hierarchy

• AbstractTermsAndConditionsElement<LogionClassificationParameters>

  ↳ LogionClassification

Table of contents

Constructors

• constructor

Accessors

• details
• expiration
• parameters
• regionalLimit
• tcLocId
• type

Methods

• checkValidity
• transferredRights
• checkValidity
• fromDetails
• validateDetails

Constructors

constructor

• new LogionClassification(licenseLocId, parameters, checkValidity?): LogionClassification

Constructs Terms and Conditions under Logion Classification.

Parameters

Name	Type	Default value	Description
licenseLocId	UUID	undefined	the ID of the defining LOC.
parameters	LogionClassificationParameters	undefined	the parameters of the classification.
checkValidity	boolean	true	whether parameters must be validated or not.

Returns

LogionClassification

Example

new LogionClassification({
  transferredRights:["PER-PRIV","REG","TIME"],
  regionalLimit:["BE","FR","US"],
  expiration:"2022-09-23"})

Overrides

AbstractTermsAndConditionsElement.constructor

Defined in

packages/client/src/license/LogionClassification.ts:284

Accessors

details

• get details(): string

Returns

string

Example

{"transferredRights":["PER-PRIV","REG","TIME"],"regionalLimit":["BE","FR","US"],"expiration":"2022-09-23"}

Overrides

AbstractTermsAndConditionsElement.details

Defined in

packages/client/src/license/LogionClassification.ts:322

---

expiration

• get expiration(): undefined | string

Provides the expiration date, if applicable.

Returns

undefined | string

the expiration date (ISO formatted), or undefined.

Defined in

packages/client/src/license/LogionClassification.ts:312

---

parameters

• get parameters(): P

Provides the parameters.

Returns

P

the parameters.

Inherited from

AbstractTermsAndConditionsElement.parameters

Defined in

packages/client/src/license/TermsAndConditions.ts:60

---

regionalLimit

• get regionalLimit(): undefined | ("AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW")[]

Provides the regional limits, if applicable.

Returns

undefined | ("AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW")[]

an array of ISO country codes, or undefined.

Defined in

packages/client/src/license/LogionClassification.ts:304

---

tcLocId

• get tcLocId(): UUID

The id of the LOC enabling the usage of this T&C.

Returns

UUID

Inherited from

AbstractTermsAndConditionsElement.tcLocId

Defined in

packages/client/src/license/TermsAndConditions.ts:52

---

type

• get type(): "logion_classification" | "specific_license" | "CC4.0"

The type of this T&C element.

Returns

"logion_classification" | "specific_license" | "CC4.0"

Inherited from

AbstractTermsAndConditionsElement.type

Defined in

packages/client/src/license/TermsAndConditions.ts:48

Methods

checkValidity

▸ checkValidity(): void

Returns

void

Defined in

packages/client/src/license/LogionClassification.ts:326

---

transferredRights

▸ transferredRights(lang?): LogionTransferredRight[]

Provides the transferred rights, in given language.

Parameters

Name	Type	Default value	Description
lang	Language	'en'	the description language.

Returns

LogionTransferredRight[]

the array of transferred rights.

Defined in

packages/client/src/license/LogionClassification.ts:296

---

checkValidity

▸ checkValidity(parameters): void

Parameters

Name	Type
parameters	LogionClassificationParameters

Returns

void

Defined in

packages/client/src/license/LogionClassification.ts:330

---

fromDetails

▸ fromDetails(licenseLocId, details, checkValidity?): LogionClassification

Constructs a new Logion Classification, based on parameters represented as a JSON string.

Parameters

Name	Type	Default value	Description
licenseLocId	UUID	undefined	the ID of the defining LOC.
details	string	undefined	JSON string of the parameters
checkValidity	boolean	true	whether parameters must be validated or not.

Returns

LogionClassification

the new Logion Classification.

Defined in

packages/client/src/license/LogionClassification.ts:362

---

validateDetails

▸ validateDetails(details): void

Parameters

Name	Type
details	string

Returns

void

Defined in

packages/client/src/license/LogionClassification.ts:370