Reference / Modules / client / LegalOfficerOpenRequestCommands

Class: LegalOfficerOpenRequestCommands

client.LegalOfficerOpenRequestCommands

Encapsulated calls can be used only by a Logion Legal Officer.

Hierarchy

• LegalOfficerCommands

  ↳ LegalOfficerOpenRequestCommands

Implements

• LegalOfficeReviewCommands
• LegalOfficerNonVoidedCommands
• LegalOfficerLocWithSelectableIssuersCommands<OpenLoc>
• LegalOfficerRestrictedDeliveryCommands

Table of contents

Constructors

• constructor

Properties

• client
• legalOfficerLocWithSelectableIssuersCommands
• legalOfficerNonVoidedCommands
• locId
• request
• restrictedDeliveryCommands
• reviewCommands

Methods

• acknowledgeFile
• acknowledgeLink
• acknowledgeMetadata
• canAutoAck
• canClose
• close
• ensureCanClose
• estimateFeesAcknowledgeFile
• estimateFeesAcknowledgeLink
• estimateFeesAcknowledgeMetadata
• getVerifiedIssuers
• isAcknowledgedOnChain
• isAllItemsAcknowledged
• isNoItem
• isPublishedOnChain
• isReadyForAutoAck
• reviewFile
• reviewLink
• reviewMetadata
• selectIssuer
• setCollectionFileRestrictedDelivery
• unselectIssuer
• voidLoc

Constructors

constructor

• new LegalOfficerOpenRequestCommands(args): LegalOfficerOpenRequestCommands

Parameters

Name	Type
args	LegalOfficerCommandsConstructorArgs

Returns

LegalOfficerOpenRequestCommands

Overrides

LegalOfficerCommands.constructor

Defined in

packages/client/src/Loc.ts:1837

Properties

client

• Protected client: AuthenticatedLocClient

Inherited from

LegalOfficerCommands.client

Defined in

packages/client/src/Loc.ts:1139

---

legalOfficerLocWithSelectableIssuersCommands

• Private legalOfficerLocWithSelectableIssuersCommands: LegalOfficerLocWithSelectableIssuersCommands<OpenLoc>

Defined in

packages/client/src/Loc.ts:1848

---

legalOfficerNonVoidedCommands

• Private legalOfficerNonVoidedCommands: LegalOfficerNonVoidedCommands

Defined in

packages/client/src/Loc.ts:1846

---

locId

• Protected locId: UUID

Inherited from

LegalOfficerCommands.locId

Defined in

packages/client/src/Loc.ts:1137

---

request

• Protected request: LocRequestState

Inherited from

LegalOfficerCommands.request

Defined in

packages/client/src/Loc.ts:1141

---

restrictedDeliveryCommands

• Private restrictedDeliveryCommands: LegalOfficerRestrictedDeliveryCommands

Defined in

packages/client/src/Loc.ts:1852

---

reviewCommands

• Private reviewCommands: LegalOfficeReviewCommands

Defined in

packages/client/src/Loc.ts:1850

Methods

acknowledgeFile

▸ acknowledgeFile(parameters): Promise<OpenLoc>

Parameters

Name	Type
parameters	AckFileParams

Returns

Promise<OpenLoc>

Defined in

packages/client/src/Loc.ts:1854

---

acknowledgeLink

▸ acknowledgeLink(parameters): Promise<OpenLoc>

Parameters

Name	Type
parameters	AckLinkParams

Returns

Promise<OpenLoc>

Defined in

packages/client/src/Loc.ts:1890

---

acknowledgeMetadata

▸ acknowledgeMetadata(parameters): Promise<OpenLoc>

Parameters

Name	Type
parameters	AckMetadataParams

Returns

Promise<OpenLoc>

Defined in

packages/client/src/Loc.ts:1872

---

canAutoAck

▸ canAutoAck(): boolean

Returns

boolean

Defined in

packages/client/src/Loc.ts:1941

---

canClose

▸ canClose(autoAck): boolean

Parameters

Name	Type
autoAck	boolean

Returns

boolean

Defined in

packages/client/src/Loc.ts:1933

---

close

▸ close(parameters): Promise<ClosedLoc | ClosedCollectionLoc>

Parameters

Name	Type
parameters	CloseLocParams

Returns

Promise<ClosedLoc | ClosedCollectionLoc>

Defined in

packages/client/src/Loc.ts:1908

---

ensureCanClose

▸ ensureCanClose(autoAck): void

Parameters

Name	Type
autoAck	boolean

Returns

void

Defined in

packages/client/src/Loc.ts:1927

---

estimateFeesAcknowledgeFile

▸ estimateFeesAcknowledgeFile(parameters): Promise<Fees>

Parameters

Name	Type
parameters	RefFileParams

Returns

Promise<Fees>

Defined in

packages/client/src/Loc.ts:1868

---

estimateFeesAcknowledgeLink

▸ estimateFeesAcknowledgeLink(parameters): Promise<Fees>

Parameters

Name	Type
parameters	RefLinkParams

Returns

Promise<Fees>

Defined in

packages/client/src/Loc.ts:1904

---

estimateFeesAcknowledgeMetadata

▸ estimateFeesAcknowledgeMetadata(parameters): Promise<Fees>

Parameters

Name	Type
parameters	RefMetadataParams

Returns

Promise<Fees>

Defined in

packages/client/src/Loc.ts:1886

---

getVerifiedIssuers

▸ getVerifiedIssuers(): Promise<VerifiedIssuerWithSelect[]>

Returns

Promise<VerifiedIssuerWithSelect[]>

Implementation of

LegalOfficerLocWithSelectableIssuersCommands.getVerifiedIssuers

Defined in

packages/client/src/Loc.ts:1977

---

isAcknowledgedOnChain

▸ isAcknowledgedOnChain(item): boolean

Parameters

Name	Type
item	ItemLifecycle & { submitter: ValidAccountId }

Returns

boolean

Defined in

packages/client/src/Loc.ts:1950

---

isAllItemsAcknowledged

▸ isAllItemsAcknowledged(): boolean

Returns

boolean

Defined in

packages/client/src/Loc.ts:1969

---

isNoItem

▸ isNoItem(predicate): boolean

Parameters

Name	Type
predicate	(item: ItemLifecycle & { submitter: ValidAccountId }) => boolean

Returns

boolean

Defined in

packages/client/src/Loc.ts:1962

---

isPublishedOnChain

▸ isPublishedOnChain(item): boolean

Parameters

Name	Type
item	ItemLifecycle & { submitter: ValidAccountId }

Returns

boolean

Defined in

packages/client/src/Loc.ts:1958

---

isReadyForAutoAck

▸ isReadyForAutoAck(item): boolean

Parameters

Name	Type
item	ItemLifecycle & { submitter: ValidAccountId }

Returns

boolean

Defined in

packages/client/src/Loc.ts:1945

---

reviewFile

▸ reviewFile(params): Promise<ReviewableRequest>

Parameters

Name	Type
params	ReviewFileParams

Returns

Promise<ReviewableRequest>

Implementation of

LegalOfficeReviewCommands.reviewFile

Defined in

packages/client/src/Loc.ts:1989

---

reviewLink

▸ reviewLink(params): Promise<ReviewableRequest>

Parameters

Name	Type
params	ReviewLinkParams

Returns

Promise<ReviewableRequest>

Implementation of

LegalOfficeReviewCommands.reviewLink

Defined in

packages/client/src/Loc.ts:1997

---

reviewMetadata

▸ reviewMetadata(params): Promise<ReviewableRequest>

Parameters

Name	Type
params	ReviewMetadataParams

Returns

Promise<ReviewableRequest>

Implementation of

LegalOfficeReviewCommands.reviewMetadata

Defined in

packages/client/src/Loc.ts:1993

---

selectIssuer

▸ selectIssuer(params): Promise<OpenLoc>

Parameters

Name	Type
params	SelectUnselectIssuerParams

Returns

Promise<OpenLoc>

Implementation of

LegalOfficerLocWithSelectableIssuersCommands.selectIssuer

Defined in

packages/client/src/Loc.ts:1981

---

setCollectionFileRestrictedDelivery

▸ setCollectionFileRestrictedDelivery(params): Promise<LocRequestState>

Parameters

Name	Type
params	Object
params.hash	Hash
params.restrictedDelivery	boolean

Returns

Promise<LocRequestState>

Implementation of

LegalOfficerRestrictedDeliveryCommands.setCollectionFileRestrictedDelivery

Defined in

packages/client/src/Loc.ts:2001

---

unselectIssuer

▸ unselectIssuer(params): Promise<OpenLoc>

Parameters

Name	Type
params	SelectUnselectIssuerParams

Returns

Promise<OpenLoc>

Implementation of

LegalOfficerLocWithSelectableIssuersCommands.unselectIssuer

Defined in

packages/client/src/Loc.ts:1985

---

voidLoc

▸ voidLoc(params): Promise<VoidedLoc | VoidedCollectionLoc>

Parameters

Name	Type
params	VoidParams

Returns

Promise<VoidedLoc | VoidedCollectionLoc>

Implementation of

LegalOfficerNonVoidedCommands.voidLoc

Defined in

packages/client/src/Loc.ts:1973