Reference / Modules / client / PublicLocClient

Class: PublicLocClient

client.PublicLocClient

Hierarchy

• LocClient

  ↳ PublicLocClient

Table of contents

Constructors

• constructor

Properties

• axiosFactory
• legalOfficer
• nodeApi

Methods

• backend
• checkDelivery
• checkTokensRecordDelivery
• getCollectionItem
• getCollectionItems
• getCollectionSize
• getDeliveries
• getLoc
• getLocRequest
• getTokensRecord
• getTokensRecordDeliveries
• getTokensRecords

Constructors

constructor

• new PublicLocClient(params): PublicLocClient

Parameters

Name	Type
params	Object
params.axiosFactory	AxiosFactory
params.legalOfficer	LegalOfficerClass
params.nodeApi	LogionNodeApiClass

Returns

PublicLocClient

Inherited from

LocClient.constructor

Defined in

packages/client/src/LocClient.ts:547

Properties

axiosFactory

• Protected Readonly axiosFactory: AxiosFactory

Inherited from

LocClient.axiosFactory

Defined in

packages/client/src/LocClient.ts:557

---

legalOfficer

• Protected Readonly legalOfficer: LegalOfficerClass

Inherited from

LocClient.legalOfficer

Defined in

packages/client/src/LocClient.ts:559

---

nodeApi

• Protected Readonly nodeApi: LogionNodeApiClass

Inherited from

LocClient.nodeApi

Defined in

packages/client/src/LocClient.ts:558

Methods

backend

▸ backend(): AxiosInstance

Returns

AxiosInstance

Inherited from

LocClient.backend

Defined in

packages/client/src/LocClient.ts:565

---

checkDelivery

▸ checkDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckCollectionDeliveryRequest

Returns

Promise<CollectionDelivery>

Overrides

LocClient.checkDelivery

Defined in

packages/client/src/LocClient.ts:736

---

checkTokensRecordDelivery

▸ checkTokensRecordDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckTokensRecordDeliveryRequest

Returns

Promise<CollectionDelivery>

Overrides

LocClient.checkTokensRecordDelivery

Defined in

packages/client/src/LocClient.ts:746

---

getCollectionItem

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

Parameters

Name	Type
parameters	{ itemId: Hash } & FetchParameters

Returns

Promise<undefined | UploadableCollectionItem>

Inherited from

LocClient.getCollectionItem

Defined in

packages/client/src/LocClient.ts:569

---

getCollectionItems

▸ getCollectionItems(parameters): Promise<UploadableCollectionItem[]>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<UploadableCollectionItem[]>

Inherited from

LocClient.getCollectionItems

Defined in

packages/client/src/LocClient.ts:611

---

getCollectionSize

▸ getCollectionSize(parameters): Promise<undefined | number>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<undefined | number>

Inherited from

LocClient.getCollectionSize

Defined in

packages/client/src/LocClient.ts:635

---

getDeliveries

▸ getDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetDeliveriesRequest

Returns

Promise<ItemDeliveries>

Overrides

LocClient.getDeliveries

Defined in

packages/client/src/LocClient.ts:730

---

getLoc

▸ getLoc(parameters): Promise<LegalOfficerCase>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LegalOfficerCase>

Inherited from

LocClient.getLoc

Defined in

packages/client/src/LocClient.ts:561

---

getLocRequest

▸ getLocRequest(parameters): Promise<LocRequest>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LocRequest>

Overrides

LocClient.getLocRequest

Defined in

packages/client/src/LocClient.ts:724

---

getTokensRecord

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

Parameters

Name	Type
parameters	{ recordId: Hash } & FetchParameters

Returns

Promise<undefined | ClientTokensRecord>

Inherited from

LocClient.getTokensRecord

Defined in

packages/client/src/LocClient.ts:640

---

getTokensRecordDeliveries

▸ getTokensRecordDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetTokensRecordDeliveriesRequest

Returns

Promise<ItemDeliveries>

Overrides

LocClient.getTokensRecordDeliveries

Defined in

packages/client/src/LocClient.ts:742

---

getTokensRecords

▸ getTokensRecords(parameters): Promise<ClientTokensRecord[]>

Parameters

Name	Type
parameters	GetTokensRecordsRequest

Returns

Promise<ClientTokensRecord[]>

Inherited from

LocClient.getTokensRecords

Defined in

packages/client/src/LocClient.ts:679