Reference / Modules / client / CreativeCommons
Class: CreativeCommons
client.CreativeCommons
Provides Terms and Conditions under the Creative Commons Attribution License 4.0
Hierarchy
-
AbstractTermsAndConditionsElement<CreativeCommonsCode>↳
CreativeCommons
Table of contents
Constructors
Accessors
Methods
Constructors
constructor
• new CreativeCommons(licenseLocId, parameters): CreativeCommons
Constructs a new CreativeCommons.
Parameters
| Name | Type | Description |
|---|---|---|
licenseLocId | UUID | the ID of the defining LOC. |
parameters | "BY" | "BY-SA" | "BY-NC" | "BY-NC-SA" | "BY-ND" | "BY-NC-ND" | the code of the selected license. |
Returns
Overrides
AbstractTermsAndConditionsElement.constructor
Defined in
packages/client/src/license/CreativeCommons.ts:20
Accessors
details
• get details(): string
The serialized details.
Returns
string
Overrides
AbstractTermsAndConditionsElement.details
Defined in
packages/client/src/license/CreativeCommons.ts:52
parameters
• get parameters(): P
Provides the parameters.
Returns
P
the parameters.
Inherited from
AbstractTermsAndConditionsElement.parameters
Defined in
packages/client/src/license/TermsAndConditions.ts:60
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
deedUrl
▸ deedUrl(language?): string
Provides the deed url in the requested language.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
language | Language | 'en' | the language |
Returns
string
the url to the
Defined in
packages/client/src/license/CreativeCommons.ts:32
fromDetails
▸ fromDetails(licenseLocId, details): CreativeCommons
Constructs a new Creative Commons, based on parameters represented as a JSON string.
Parameters
| Name | Type | Description |
|---|---|---|
licenseLocId | UUID | the ID of the defining LOC. |
details | string | JSON string of the parameters |
Returns
the new Creative Commons
Defined in
packages/client/src/license/CreativeCommons.ts:42
validateDetails
▸ validateDetails(details): void
Parameters
| Name | Type |
|---|---|
details | string |
Returns
void