Reference / Modules / client / LocClient

Class: LocClient

client.LocClient

Hierarchy

• LocClient

  ↳ PublicLocClient

  ↳ AuthenticatedLocClient

Table of contents

Constructors

• constructor

Properties

• axiosFactory
• legalOfficer
• nodeApi

Methods

• backend
• checkDelivery
• checkTokensRecordDelivery
• getCollectionItem
• getCollectionItems
• getCollectionSize
• getDeliveries
• getLoc
• getLocRequest
• getOffchainItem
• getOffchainItems
• getOffchainRecord
• getOffchainTokensRecords
• getTokensRecord
• getTokensRecordDeliveries
• getTokensRecords
• mergeItems
• mergeRecords

Constructors

constructor

• new LocClient(params): LocClient

Parameters

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

Returns

LocClient

Defined in

packages/client/src/LocClient.ts:547

Properties

axiosFactory

• Protected Readonly axiosFactory: AxiosFactory

Defined in

packages/client/src/LocClient.ts:557

---

legalOfficer

• Protected Readonly legalOfficer: LegalOfficerClass

Defined in

packages/client/src/LocClient.ts:559

---

nodeApi

• Protected Readonly nodeApi: LogionNodeApiClass

Defined in

packages/client/src/LocClient.ts:558

Methods

backend

▸ backend(): AxiosInstance

Returns

AxiosInstance

Defined in

packages/client/src/LocClient.ts:565

---

checkDelivery

▸ checkDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckCollectionDeliveryRequest

Returns

Promise<CollectionDelivery>

Defined in

packages/client/src/LocClient.ts:715

---

checkTokensRecordDelivery

▸ checkTokensRecordDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckTokensRecordDeliveryRequest

Returns

Promise<CollectionDelivery>

Defined in

packages/client/src/LocClient.ts:719

---

getCollectionItem

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

Parameters

Name	Type
parameters	{ itemId: Hash } & FetchParameters

Returns

Promise<undefined | UploadableCollectionItem>

Defined in

packages/client/src/LocClient.ts:569

---

getCollectionItems

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

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<UploadableCollectionItem[]>

Defined in

packages/client/src/LocClient.ts:611

---

getCollectionSize

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

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<undefined | number>

Defined in

packages/client/src/LocClient.ts:635

---

getDeliveries

▸ getDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetDeliveriesRequest

Returns

Promise<ItemDeliveries>

Defined in

packages/client/src/LocClient.ts:713

---

getLoc

▸ getLoc(parameters): Promise<LegalOfficerCase>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LegalOfficerCase>

Defined in

packages/client/src/LocClient.ts:561

---

getLocRequest

▸ getLocRequest(parameters): Promise<LocRequest>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LocRequest>

Defined in

packages/client/src/LocClient.ts:711

---

getOffchainItem

▸ getOffchainItem(parameters): Promise<OffchainCollectionItem>

Parameters

Name	Type
parameters	Object
parameters.itemId	Hash
parameters.locId	UUID

Returns

Promise<OffchainCollectionItem>

Defined in

packages/client/src/LocClient.ts:583

---

getOffchainItems

▸ getOffchainItems(parameters): Promise<OffchainCollectionItem[]>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID

Returns

Promise<OffchainCollectionItem[]>

Defined in

packages/client/src/LocClient.ts:629

---

getOffchainRecord

▸ getOffchainRecord(parameters): Promise<OffchainTokensRecord>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.recordId	Hash

Returns

Promise<OffchainTokensRecord>

Defined in

packages/client/src/LocClient.ts:657

---

getOffchainTokensRecords

▸ getOffchainTokensRecords(parameters): Promise<OffchainTokensRecord[]>

Parameters

Name	Type
parameters	GetTokensRecordsRequest

Returns

Promise<OffchainTokensRecord[]>

Defined in

packages/client/src/LocClient.ts:702

---

getTokensRecord

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

Parameters

Name	Type
parameters	{ recordId: Hash } & FetchParameters

Returns

Promise<undefined | ClientTokensRecord>

Defined in

packages/client/src/LocClient.ts:640

---

getTokensRecordDeliveries

▸ getTokensRecordDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetTokensRecordDeliveriesRequest

Returns

Promise<ItemDeliveries>

Defined in

packages/client/src/LocClient.ts:717

---

getTokensRecords

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

Parameters

Name	Type
parameters	GetTokensRecordsRequest

Returns

Promise<ClientTokensRecord[]>

Defined in

packages/client/src/LocClient.ts:679

---

mergeItems

▸ mergeItems(onchainItem, offchainItem): UploadableCollectionItem

Parameters

Name	Type
onchainItem	CollectionItem
offchainItem	OffchainCollectionItem

Returns

UploadableCollectionItem

Defined in

packages/client/src/LocClient.ts:589

---

mergeRecords

▸ mergeRecords(onchainItem, offchainItem): ClientTokensRecord

Parameters

Name	Type
onchainItem	TypesTokensRecord
offchainItem	OffchainTokensRecord

Returns

ClientTokensRecord

Defined in

packages/client/src/LocClient.ts:663