Reference / Modules / client / VoidedCollectionLoc

Class: VoidedCollectionLoc

client.VoidedCollectionLoc

Hierarchy

• ClosedOrVoidCollectionLoc

  ↳ VoidedCollectionLoc

Table of contents

Constructors

• constructor

Properties

• invitedContributors
• legalOfficerCase
• locIssuers
• locSharedState
• owner
• request

Accessors

• discarded
• locId

Methods

• _withLocs
• checkHash
• data
• discard
• discardOnSuccess
• ensureCurrent
• finalizeOnSuccess
• getCollectionItem
• getCollectionItems
• getCurrentState
• getCurrentStateOrThrow
• getFile
• getTokensRecord
• getTokensRecords
• isLogionData
• isLogionIdentity
• isOwner
• isRequester
• isVerifiedIssuer
• locsState
• refresh
• replacerLoc
• size
• supersededLoc
• syncDiscardOnSuccess
• withLocs
• buildLocData
• checkHash
• createFromLoc
• createFromRequest
• toCollectionParams

Constructors

constructor

• new VoidedCollectionLoc(locSharedState, request, legalOfficerCase, locIssuers, invitedContributors): VoidedCollectionLoc

Parameters

Name	Type
locSharedState	LocSharedState
request	LocRequest
legalOfficerCase	undefined | LegalOfficerCase
locIssuers	LocVerifiedIssuers
invitedContributors	ValidAccountId[]

Returns

VoidedCollectionLoc

Inherited from

ClosedOrVoidCollectionLoc.constructor

Defined in

packages/client/src/Loc.ts:766

Properties

invitedContributors

• Protected Readonly invitedContributors: ValidAccountId[]

Inherited from

ClosedOrVoidCollectionLoc.invitedContributors

Defined in

packages/client/src/Loc.ts:763

---

legalOfficerCase

• Protected Optional Readonly legalOfficerCase: LegalOfficerCase

Inherited from

ClosedOrVoidCollectionLoc.legalOfficerCase

Defined in

packages/client/src/Loc.ts:761

---

locIssuers

• Protected Readonly locIssuers: LocVerifiedIssuers

Inherited from

ClosedOrVoidCollectionLoc.locIssuers

Defined in

packages/client/src/Loc.ts:762

---

locSharedState

• Protected Readonly locSharedState: LocSharedState

Inherited from

ClosedOrVoidCollectionLoc.locSharedState

Defined in

packages/client/src/Loc.ts:759

---

owner

• Readonly owner: LegalOfficerClass

Inherited from

ClosedOrVoidCollectionLoc.owner

Defined in

packages/client/src/Loc.ts:764

---

request

• Protected Readonly request: LocRequest

Inherited from

ClosedOrVoidCollectionLoc.request

Defined in

packages/client/src/Loc.ts:760

Accessors

discarded

• get discarded(): boolean

Returns

boolean

Description

True if this state was discarded

Inherited from

ClosedOrVoidCollectionLoc.discarded

Defined in

packages/client/src/State.ts:24

---

locId

• get locId(): UUID

Returns

UUID

Inherited from

ClosedOrVoidCollectionLoc.locId

Defined in

packages/client/src/Loc.ts:781

Methods

_withLocs

▸ _withLocs<T>(locsState, constructor): T

Type parameters

Name	Type
T	extends LocRequestState

Parameters

Name	Type
locsState	LocsState
constructor	(locSharedState: LocSharedState, request: LocRequest, legalOfficerCase: undefined | LegalOfficerCase, locIssuers: LocVerifiedIssuers, invitedContributors: ValidAccountId[]) => T

Returns

T

Inherited from

ClosedOrVoidCollectionLoc._withLocs

Defined in

packages/client/src/Loc.ts:1096

---

checkHash

▸ checkHash(hash): Promise<CheckHashResult>

Parameters

Name	Type
hash	Hash

Returns

Promise<CheckHashResult>

Inherited from

ClosedOrVoidCollectionLoc.checkHash

Defined in

packages/client/src/Loc.ts:2237

---

data

▸ data(): LocData

Returns

LocData

Inherited from

ClosedOrVoidCollectionLoc.data

Defined in

packages/client/src/Loc.ts:839

---

discard

▸ discard(next): void

Parameters

Name	Type
next	undefined | State

Returns

void

Description

Discards current state. One must discard the state only if the state transition was successfully executed. It may be safer to use discardOnSuccess.

Inherited from

ClosedOrVoidCollectionLoc.discard

Defined in

packages/client/src/State.ts:43

---

discardOnSuccess

▸ discardOnSuccess<T, U>(action): Promise<U>

Type parameters

Name	Type
T	extends State
U	extends State = T

Parameters

Name	Type	Description
action	(current: T) => Promise<U>	The state transition logic producing next state

Returns

Promise<U>

Next state if state transition logic execution did not throw

Descripiton

Discards current state only if given state transition logic executed successfully (i.e. without throwing an error).

Inherited from

ClosedOrVoidCollectionLoc.discardOnSuccess

Defined in

packages/client/src/State.ts:55

---

ensureCurrent

▸ ensureCurrent(): void

Returns

void

Description

Throws an error if this state was discarded. This should be called by all public methods of client class.

Inherited from

ClosedOrVoidCollectionLoc.ensureCurrent

Defined in

packages/client/src/State.ts:32

---

finalizeOnSuccess

▸ finalizeOnSuccess<T>(action): Promise<void>

Type parameters

Name	Type
T	extends State

Parameters

Name	Type	Description
action	(current: T) => Promise<void>	The state transition logic producing next state

Returns

Promise<void>

Next state if state transition logic execution did not throw

Descripiton

Finalizes (i.e. replaces with no new state) current state only if given state transition logic executed successfully (i.e. without throwing an error).

Inherited from

ClosedOrVoidCollectionLoc.finalizeOnSuccess

Defined in

packages/client/src/State.ts:117

---

getCollectionItem

▸ getCollectionItem(parameters): Promise<undefined | CollectionItem>

Parameters

Name	Type
parameters	Object
parameters.itemId	Hash

Returns

Promise<undefined | CollectionItem>

Inherited from

ClosedOrVoidCollectionLoc.getCollectionItem

Defined in

packages/client/src/Loc.ts:2218

---

getCollectionItems

▸ getCollectionItems(): Promise<CollectionItem[]>

Returns

Promise<CollectionItem[]>

Inherited from

ClosedOrVoidCollectionLoc.getCollectionItems

Defined in

packages/client/src/Loc.ts:2226

---

getCurrentState

▸ getCurrentState(): undefined | State

Returns

undefined | State

This state if not discareded or the current state or undefined when there is no current state.

Description

If the state has been discarded, provides the replacing current state if any.

Inherited from

ClosedOrVoidCollectionLoc.getCurrentState

Defined in

packages/client/src/State.ts:90

---

getCurrentStateOrThrow

▸ getCurrentStateOrThrow(): State

Returns

State

Inherited from

ClosedOrVoidCollectionLoc.getCurrentStateOrThrow

Defined in

packages/client/src/State.ts:102

---

getFile

▸ getFile(hash): Promise<TypedFile>

Parameters

Name	Type
hash	Hash

Returns

Promise<TypedFile>

Inherited from

ClosedOrVoidCollectionLoc.getFile

Defined in

packages/client/src/Loc.ts:1103

---

getTokensRecord

▸ getTokensRecord(parameters): Promise<undefined | TokensRecord>

Parameters

Name	Type
parameters	Object
parameters.recordId	Hash

Returns

Promise<undefined | TokensRecord>

Inherited from

ClosedOrVoidCollectionLoc.getTokensRecord

Defined in

packages/client/src/Loc.ts:2253

---

getTokensRecords

▸ getTokensRecords(): Promise<TokensRecord[]>

Returns

Promise<TokensRecord[]>

Inherited from

ClosedOrVoidCollectionLoc.getTokensRecords

Defined in

packages/client/src/Loc.ts:2261

---

isLogionData

▸ isLogionData(): boolean

Returns

boolean

Inherited from

ClosedOrVoidCollectionLoc.isLogionData

Defined in

packages/client/src/Loc.ts:864

---

isLogionIdentity

▸ isLogionIdentity(): boolean

Returns

boolean

Inherited from

ClosedOrVoidCollectionLoc.isLogionIdentity

Defined in

packages/client/src/Loc.ts:859

---

isOwner

▸ isOwner(account?): boolean

Parameters

Name	Type
account?	ValidAccountId

Returns

boolean

Inherited from

ClosedOrVoidCollectionLoc.isOwner

Defined in

packages/client/src/Loc.ts:1112

---

isRequester

▸ isRequester(account?): boolean

Parameters

Name	Type
account?	ValidAccountId

Returns

boolean

Inherited from

ClosedOrVoidCollectionLoc.isRequester

Defined in

packages/client/src/Loc.ts:1107

---

isVerifiedIssuer

▸ isVerifiedIssuer(account?): boolean

Parameters

Name	Type
account?	ValidAccountId

Returns

boolean

Inherited from

ClosedOrVoidCollectionLoc.isVerifiedIssuer

Defined in

packages/client/src/Loc.ts:1117

---

locsState

▸ locsState(): LocsState

Returns

LocsState

Inherited from

ClosedOrVoidCollectionLoc.locsState

Defined in

packages/client/src/Loc.ts:835

---

refresh

▸ refresh(): Promise<VoidedCollectionLoc>

Returns

Promise<VoidedCollectionLoc>

Overrides

ClosedOrVoidCollectionLoc.refresh

Defined in

packages/client/src/Loc.ts:2494

---

replacerLoc

▸ replacerLoc(): Promise<undefined | OpenLoc | ClosedCollectionLoc | VoidedCollectionLoc>

Returns

Promise<undefined | OpenLoc | ClosedCollectionLoc | VoidedCollectionLoc>

Defined in

packages/client/src/Loc.ts:2486

---

size

▸ size(): Promise<undefined | number>

Returns

Promise<undefined | number>

Inherited from

ClosedOrVoidCollectionLoc.size

Defined in

packages/client/src/Loc.ts:2246

---

supersededLoc

▸ supersededLoc(): Promise<undefined | VoidedLoc>

Returns

Promise<undefined | VoidedLoc>

Inherited from

ClosedOrVoidCollectionLoc.supersededLoc

Defined in

packages/client/src/Loc.ts:851

---

syncDiscardOnSuccess

▸ syncDiscardOnSuccess<T, U>(action): U

Type parameters

Name	Type
T	extends State
U	extends State = T

Parameters

Name	Type	Description
action	(current: T) => U	The state transition logic producing next state

Returns

U

Next state if state transition logic execution did not throw

Descripiton

Same as discardOnSuccess but with a synchronous action.

Inherited from

ClosedOrVoidCollectionLoc.syncDiscardOnSuccess

Defined in

packages/client/src/State.ts:73

---

withLocs

▸ withLocs(locsState): VoidedCollectionLoc

Parameters

Name	Type
locsState	LocsState

Returns

VoidedCollectionLoc

Overrides

ClosedOrVoidCollectionLoc.withLocs

Defined in

packages/client/src/Loc.ts:2498

---

buildLocData

▸ buildLocData(api, legalOfficerCase, request, locIssuers, invitedContributors): LocData

Parameters

Name	Type
api	LogionNodeApiClass
legalOfficerCase	undefined | LegalOfficerCase
request	LocRequest
locIssuers	LocVerifiedIssuers
invitedContributors	ValidAccountId[]

Returns

LocData

Inherited from

ClosedOrVoidCollectionLoc.buildLocData

Defined in

packages/client/src/Loc.ts:843

---

checkHash

▸ checkHash(loc, hash): CheckHashResult

Parameters

Name	Type
loc	LocData
hash	Hash

Returns

CheckHashResult

Inherited from

ClosedOrVoidCollectionLoc.checkHash

Defined in

packages/client/src/Loc.ts:873

---

createFromLoc

▸ createFromLoc(locSharedState, request, legalOfficerCase, locIssuers, invitedContributors): Promise<OnchainLocState>

Parameters

Name	Type
locSharedState	LocSharedState
request	LocRequest
legalOfficerCase	LegalOfficerCase
locIssuers	LocVerifiedIssuers
invitedContributors	ValidAccountId[]

Returns

Promise<OnchainLocState>

Inherited from

ClosedOrVoidCollectionLoc.createFromLoc

Defined in

packages/client/src/Loc.ts:800

---

createFromRequest

▸ createFromRequest(locSharedState, request, locIssuers, invitedContributors, legalOfficerCase?): Promise<AnyLocState>

Parameters

Name	Type
locSharedState	LocSharedState
request	LocRequest
locIssuers	LocVerifiedIssuers
invitedContributors	ValidAccountId[]
legalOfficerCase?	LegalOfficerCase

Returns

Promise<AnyLocState>

Inherited from

ClosedOrVoidCollectionLoc.createFromRequest

Defined in

packages/client/src/Loc.ts:785

---

toCollectionParams

▸ toCollectionParams(collectionParams): undefined | CollectionParams

Parameters

Name	Type
collectionParams	undefined | BackendCollectionParams

Returns

undefined | CollectionParams

Inherited from

ClosedOrVoidCollectionLoc.toCollectionParams

Defined in

packages/client/src/Loc.ts:921