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

    Class UtilityPageDoc<T>

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    _docId: string

    A unique stringified document ID

    _id?: string

    A unique document ID (Mongo DB ObjectID)

    approvalStatus: {
        featuredPriority?: number;
        isApproved: boolean;
        isFeatured?: boolean;
        reason?: string;
        rejected?: boolean;
        updatedBy?: string;
    }

    Approval status - can be used for moderation

    categories: string[]

    The categories of the listing

    The paginated content for the listing

    createdAt: T

    The time the listing was created

    createdBy: string

    The BitBadges address of the user who created this listing

    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 [].

    displayTimes?: UintRange<T>

    Optional time range for when the listing should be shown

    estimatedCost?: EstimatedCost<T>

    The estimated cost for this utility/service

    estimatedTime?: string

    The estimated time to complete or deliver this utility/service

    homePageView?: {
        category: string;
        type: "tokens" | "lists" | "claims" | "applications";
    }

    Home page view

    inheritMetadataFrom?: InheritMetadataFrom<T>

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

    lastUpdated?: T

    The last updated timestamp

    linkedTo?: LinkedTo<T>

    Linked details

    links: UtilityPageLink<T>[]

    The relevant links for the listing

    listingId: string

    The listing ID

    locale?: string

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

    managedBy: string

    The BitBadges address of the user who is currently managing this

    metadata: iMetadata<T>

    The overall metadata for the listing

    type: string

    Type of the listing

    viewCount?: T

    The total view count for this listing. This is updated periodically from the view tracking document.

    viewsByPeriod?: {
        daily: number;
        hourly: number;
        monthly: number;
        weekly: number;
    }

    Optional breakdown of views by time period for trending calculations

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

    Visibility state of the listing

    Methods