bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface iUpdateUtilityPagePayload<T>

    interface iUpdateUtilityPagePayload<T extends NumberType> {
        categories: string[];
        content: iUtilityPageContent[];
        directLink?: string;
        displayTimes?: iUintRange<T>;
        estimatedCost?: iEstimatedCost<T>;
        estimatedTime?: string;
        inheritMetadataFrom?: iInheritMetadataFrom<T>;
        linkedTo?: iLinkedTo<T>;
        links: iUtilityPageLink<T>[];
        listingId: string;
        locale?: string;
        metadata: iMetadataWithoutInternals<T>;
        visibility: "public" | "private" | "unlisted";
    }

    Type Parameters

    Index

    Properties

    categories content directLink? displayTimes? estimatedCost? estimatedTime? inheritMetadataFrom? linkedTo? links listingId locale? metadata visibility

    Properties

    categories: string[]

    The categories of the listing

    content

    content: iUtilityPageContent[]

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

    directLink?: string

    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?: iUintRange<T>

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

    estimatedCost?: iEstimatedCost<T>

    The estimated cost for this utility/service

    estimatedTime?: string

    The estimated time to complete or deliver this utility/service

    inheritMetadataFrom?: iInheritMetadataFrom<T>

    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?: iLinkedTo<T>

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

    links: iUtilityPageLink<T>[]

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

    listingId: string

    The listing ID to update

    locale?: string

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

    metadata: iMetadataWithoutInternals<T>

    The overall metadata for the listing

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

    The visibility of the listing

    Settings

    Member Visibility

    On This Page

    Properties