Skip to content

Class: UtilityPageDoc<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1308

Extends

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

new UtilityPageDoc<T>(data): UtilityPageDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1344

Parameters

data

iUtilityPageDoc<T>

Returns

UtilityPageDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1309

A unique stringified document ID

Implementation of

iUtilityPageDoc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1310

A unique document ID (Mongo DB ObjectID)

Implementation of

iUtilityPageDoc._id

approvalStatus

approvalStatus: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1323

Approval status - can be used for moderation

featuredPriority?

optional featuredPriority?: number

isApproved

isApproved: boolean

isFeatured?

optional isFeatured?: boolean

reason?

optional reason?: string

rejected?

optional rejected?: boolean

updatedBy?

optional updatedBy?: string

Implementation of

iUtilityPageDoc.approvalStatus

categories

categories: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1313

The categories of the listing

Implementation of

iUtilityPageDoc.categories

content

content: UtilityPageContent[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1318

The paginated content for the listing

Implementation of

iUtilityPageDoc.content

createdAt

createdAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1317

The time the listing was created

Implementation of

iUtilityPageDoc.createdAt

createdBy

createdBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1315

The BitBadges address of the user who created this listing

Implementation of

iUtilityPageDoc.createdBy

optional directLink?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1314

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

Implementation of

iUtilityPageDoc.directLink

displayTimes?

optional displayTimes?: UintRange<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1331

Optional time range for when the listing should be shown

Implementation of

iUtilityPageDoc.displayTimes

estimatedCost?

optional estimatedCost?: EstimatedCost<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1337

The estimated cost for this utility/service

Implementation of

iUtilityPageDoc.estimatedCost

estimatedTime?

optional estimatedTime?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1338

The estimated time to complete or deliver this utility/service

Implementation of

iUtilityPageDoc.estimatedTime

homePageView?

optional homePageView?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1339

Home page view

category

category: string

type

type: "tokens" | "lists" | "claims" | "applications"

Implementation of

iUtilityPageDoc.homePageView

inheritMetadataFrom?

optional inheritMetadataFrom?: InheritMetadataFrom<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1335

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

Implementation of

iUtilityPageDoc.inheritMetadataFrom

lastUpdated?

optional lastUpdated?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1322

The last updated timestamp

Implementation of

iUtilityPageDoc.lastUpdated

linkedTo?

optional linkedTo?: LinkedTo<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1334

Linked details

Implementation of

iUtilityPageDoc.linkedTo

links: UtilityPageLink<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1319

The relevant links for the listing

Implementation of

iUtilityPageDoc.links

listingId

listingId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1311

The listing ID

Implementation of

iUtilityPageDoc.listingId

locale?

optional locale?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1336

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

Implementation of

iUtilityPageDoc.locale

managedBy

managedBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1316

The BitBadges address of the user who is currently managing this

Implementation of

iUtilityPageDoc.managedBy

metadata

metadata: iMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1320

The overall metadata for the listing

Implementation of

iUtilityPageDoc.metadata

type

type: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1312

Type of the listing

Implementation of

iUtilityPageDoc.type

viewCount?

optional viewCount?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1332

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

Implementation of

iUtilityPageDoc.viewCount

viewsByPeriod?

optional viewsByPeriod?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1333

Optional breakdown of views by time period for trending calculations

daily

daily: number

hourly

hourly: number

monthly

monthly: number

weekly

weekly: number

Implementation of

iUtilityPageDoc.viewsByPeriod

visibility

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1321

Visibility state of the listing

Implementation of

iUtilityPageDoc.visibility

Methods

clone()

clone(): UtilityPageDoc

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns

UtilityPageDoc

Inherited from

BaseNumberTypeClass.clone

convert()

convert<U>(convertFunction, options?): UtilityPageDoc<U>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1376

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

UtilityPageDoc<U>

Overrides

BaseNumberTypeClass.convert

equals()

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters

U

U extends CustomType<U>

Parameters

other

CustomType<U> | null | undefined

normalizeNumberTypes?

boolean

Returns

boolean

Inherited from

BaseNumberTypeClass.equals

getNumberFieldNames()

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1372

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns

string[]

Overrides

BaseNumberTypeClass.getNumberFieldNames

hasNumberFields()

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns

boolean

Inherited from

BaseNumberTypeClass.hasNumberFields

toJson()

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns

JsonObject

Inherited from

BaseNumberTypeClass.toJson

toJsonString()

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns

string

Inherited from

BaseNumberTypeClass.toJsonString

Edit this page on GitHub