Skip to main content

Reference / Modules / client / PublicApi

Class: PublicApi

client.PublicApi

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new PublicApi(args): PublicApi

Parameters​

NameType
argsObject
args.sharedStateSharedState

Returns​

PublicApi

Defined in​

packages/client/src/Public.ts:19

Properties​

fees​

• Readonly fees: FeesEstimator

Defined in​

packages/client/src/Public.ts:28


sharedState​

• Private sharedState: SharedState

Defined in​

packages/client/src/Public.ts:26

Methods​

findCollectionLocItemById​

▸ findCollectionLocItemById(params): Promise<undefined | CollectionItem>

Parameters​

NameType
paramsObject
params.itemIdHash
params.locIdUUID

Returns​

Promise<undefined | CollectionItem>

Defined in​

packages/client/src/Public.ts:65


findLocById​

▸ findLocById(params): Promise<undefined | PublicLoc>

Parameters​

NameType
paramsFetchParameters

Returns​

Promise<undefined | PublicLoc>

Defined in​

packages/client/src/Public.ts:30


getLocAndClient​

▸ getLocAndClient(params): Promise<undefined | { client: LocClient ; loc: LegalOfficerCase }>

Parameters​

NameType
paramsFetchParameters

Returns​

Promise<undefined | { client: LocClient ; loc: LegalOfficerCase }>

Defined in​

packages/client/src/Public.ts:45


getTokensRecord​

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

Parameters​

NameType
paramsObject
params.locIdUUID
params.recordIdHash

Returns​

Promise<undefined | TokensRecord>

Defined in​

packages/client/src/Public.ts:94


getTokensRecords​

▸ getTokensRecords(params): Promise<TokensRecord[]>

Parameters​

NameType
paramsGetTokensRecordsRequest

Returns​

Promise<TokensRecord[]>

Defined in​

packages/client/src/Public.ts:79