Skip to content

Interface: iUpdateUtilityPagePayload<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3651

Type Parameters

T

T extends NumberType

Properties

categories

categories: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3678

The categories of the listing

content

content: iUtilityPageContent[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3659

The content for the listing. This is only used for a dedicated listing page (not compatible with direct link or inherited metadata).

optional directLink?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3675

The direct link for the listing. If specified, we will skip the entire content / listing page. Thus, content and links should be empty [].

This is incompatible with inherited metadata.

displayTimes?

optional displayTimes?: iUintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3668

The display times of the listing. Optionally specify when to show vs not show the listing.

estimatedCost?

optional estimatedCost?: iEstimatedCost<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3697

The estimated cost for this utility/service

estimatedTime?

optional estimatedTime?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3700

The estimated time to complete or deliver this utility/service

inheritMetadataFrom?

optional inheritMetadataFrom?: iInheritMetadataFrom<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3691

Where to inherit metadata from? Only one can be specified.

If specified, we automatically override the metadata from what is specified and automatically set a direct link to the page.

Ex: Inherit claim metadata and direct link to the claim page.

linkedTo?

optional linkedTo?: iLinkedTo<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3681

The details for if this listing is linked to a specific collection or list (displayed in Utility tab)

links: iUtilityPageLink<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3662

The links for the listing. This is only used for a dedicated listing page (not compatible with direct link or inherited metadata).

listingId

listingId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3653

The listing ID to update

locale?

optional locale?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3694

Locale (ex: es, fr, etc.). If not specified, we assume "en" (English).

metadata

metadata: iMetadataWithoutInternals<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3656

The overall metadata for the listing

visibility

visibility: "public" | "private" | "unlisted"

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:3665

The visibility of the listing

Edit this page on GitHub