Reference / Modules / client / CollectionItem
Class: CollectionItem
client.CollectionItem
Implements
Table of contents
Constructors
Properties
Accessors
- addedOn
- creativeCommons
- description
- files
- id
- locId
- logionClassification
- restrictedDelivery
- specificLicenses
- termsAndConditions
- token
Methods
Constructors
constructor
• new CollectionItem(args): CollectionItem
Parameters
| Name | Type |
|---|---|
args | Object |
args.clientItem | UploadableCollectionItem |
args.locClient | LocClient |
args.locId | UUID |
Returns
Defined in
packages/client/src/CollectionItem.ts:12
Properties
_creativeCommons
• Private Readonly _creativeCommons: undefined | CreativeCommons
Defined in
packages/client/src/CollectionItem.ts:58
_locId
• Private Readonly _locId: UUID
Defined in
packages/client/src/CollectionItem.ts:48
_logionClassification
• Private Readonly _logionClassification: undefined | LogionClassification
Defined in
packages/client/src/CollectionItem.ts:54
_specificLicenses
• Private Readonly _specificLicenses: SpecificLicense[]
Defined in
packages/client/src/CollectionItem.ts:56
clientItem
• Private clientItem: UploadableCollectionItem
Defined in
packages/client/src/CollectionItem.ts:52
locClient
• Private locClient: LocClient
Defined in
packages/client/src/CollectionItem.ts:50
Accessors
addedOn
• get addedOn(): string
Returns
string
Implementation of
UploadableCollectionItem.addedOn
Defined in
packages/client/src/CollectionItem.ts:72
creativeCommons
• get creativeCommons(): undefined | CreativeCommons
Returns
undefined | CreativeCommons
Defined in
packages/client/src/CollectionItem.ts:100
description
• get description(): HashString
Returns
Implementation of
UploadableCollectionItem.description
Defined in
packages/client/src/CollectionItem.ts:68
files
• get files(): UploadableItemFile[]
Returns
Implementation of
UploadableCollectionItem.files
Defined in
packages/client/src/CollectionItem.ts:76
id
• get id(): Hash
Returns
Hash
Implementation of
Defined in
packages/client/src/CollectionItem.ts:64
locId
• get locId(): UUID
Returns
UUID
Defined in
packages/client/src/CollectionItem.ts:60
logionClassification
• get logionClassification(): undefined | LogionClassification
Returns
undefined | LogionClassification
Defined in
packages/client/src/CollectionItem.ts:92
restrictedDelivery
• get restrictedDelivery(): boolean
Returns
boolean
Implementation of
UploadableCollectionItem.restrictedDelivery
Defined in
packages/client/src/CollectionItem.ts:84
specificLicenses
• get specificLicenses(): SpecificLicense[]
Returns
Defined in
packages/client/src/CollectionItem.ts:96
termsAndConditions
• get termsAndConditions(): MergedTermsAndConditionsElement[]
Returns
MergedTermsAndConditionsElement[]
Implementation of
UploadableCollectionItem.termsAndConditions
Defined in
packages/client/src/CollectionItem.ts:88
token
• get token(): undefined | ClientToken
Returns
undefined | ClientToken
Implementation of
UploadableCollectionItem.token
Defined in
packages/client/src/CollectionItem.ts:80
Methods
checkCertifiedCopy
▸ checkCertifiedCopy(hash): Promise<CheckCertifiedCopyResult>
Parameters
| Name | Type |
|---|---|
hash | Hash |
Returns
Promise<CheckCertifiedCopyResult>
Defined in
packages/client/src/CollectionItem.ts:114
checkHash
▸ checkHash(hash): CheckHashResult
Parameters
| Name | Type |
|---|---|
hash | Hash |
Returns
Defined in
packages/client/src/CollectionItem.ts:108
getFile
▸ getFile(hash): Promise<TypedFile>
Parameters
| Name | Type |
|---|---|
hash | Hash |
Returns
Promise<TypedFile>
Defined in
packages/client/src/CollectionItem.ts:132
getItemFile
▸ getItemFile(hash): undefined | UploadableItemFile
Parameters
| Name | Type |
|---|---|
hash | Hash |
Returns
undefined | UploadableItemFile
Defined in
packages/client/src/CollectionItem.ts:104
isAuthenticatedTokenOwner
▸ isAuthenticatedTokenOwner(): Promise<boolean>
Returns
Promise<boolean>