Interface: iUtilityPageDoc<T>

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

Extends#

• Doc

Type Parameters#

T#

T extends NumberType

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from#

Doc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from#

Doc._id

---

approvalStatus#

approvalStatus: object

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

Approval status - can be used for moderation

featuredPriority?#

optional featuredPriority?: number

Featured Priority

isApproved#

isApproved: boolean

Whether the listing is approved

isFeatured?#

optional isFeatured?: boolean

Is Featured

reason?#

optional reason?: string

Optional reason if not approved

rejected?#

optional rejected?: boolean

Rejected or just pending

updatedBy?#

optional updatedBy?: string

Address of who last updated the approval status

---

categories#

categories: string[]

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

The categories of the listing

---

content#

content: iUtilityPageContent[]

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

The paginated content for the listing

---

createdAt#

createdAt: T

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

The time the listing was created

---

createdBy#

createdBy: string

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

The BitBadges address of the user who created this listing

---

directLink?#

optional directLink?: string

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

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

---

displayTimes?#

optional displayTimes?: iUintRange<T>

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

Optional time range for when the listing should be shown

---

estimatedCost?#

optional estimatedCost?: iEstimatedCost<T>

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

The estimated cost for this utility/service

---

estimatedTime?#

optional estimatedTime?: string

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

The estimated time to complete or deliver this utility/service

---

homePageView?#

optional homePageView?: object

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

Home page view

category#

category: string

type#

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

---

inheritMetadataFrom?#

optional inheritMetadataFrom?: iInheritMetadataFrom<T>

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

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

---

lastUpdated?#

optional lastUpdated?: T

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

The last updated timestamp

---

linkedTo?#

optional linkedTo?: iLinkedTo<T>

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

Linked details

---

links#

links: iUtilityPageLink<T>[]

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

The relevant links for the listing

---

listingId#

listingId: string

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

The listing ID

---

locale?#

optional locale?: string

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

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

---

managedBy#

managedBy: string

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

The BitBadges address of the user who is currently managing this

---

metadata#

metadata: iMetadata<T>

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

The overall metadata for the listing

---

type#

type: string

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

Type of the listing

---

viewCount?#

optional viewCount?: T

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

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

---

viewsByPeriod?#

optional viewsByPeriod?: object

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

Optional breakdown of views by time period for trending calculations

daily#

daily: number

Views in the last 24 hours

hourly#

hourly: number

Views in the last hour

monthly#

monthly: number

Views in the last 30 days

weekly#

weekly: number

Views in the last 7 days

---

visibility#

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

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

Visibility state of the listing