Skip to content

Interface: iQueueDoc<T>

T extends NumberType

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

Extends

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

actionConfig?

optional actionConfig?: any

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

For use for post-claim actions

activityDocId?

optional activityDocId?: string

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

claimInfo?

optional claimInfo?: object

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

For use for claim completion

Index Signature

[key: string]: any

bitbadgesAddress

bitbadgesAddress: string

body

body: any

claimId

claimId: string

ip

ip: string | undefined

session

session: any

collectionId

collectionId: string

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

The collection ID of the metadata to be fetched

deletedAt?

optional deletedAt?: T

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

The timestamp of when this document was deleted (milliseconds since epoch)

emailMessage?

optional emailMessage?: string

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

error?

optional error?: string

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

The error message if this metadata failed to be fetched

faucetInfo?

optional faucetInfo?: object

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

For use for airdrops

amount

amount: NumberType

denom

denom: string

recipient

recipient: string

txHash

txHash: string

initiatedBy?

optional initiatedBy?: string

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

The BitBadges address of the user who initiated this fetch

lastFetchedAt?

optional lastFetchedAt?: T

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

The timestamp of when this metadata was last fetched (milliseconds since epoch)

loadBalanceId

loadBalanceId: T

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

The load balance ID of the metadata to be fetched. Only the node with the same load balance ID will fetch this metadata

nextFetchTime?

optional nextFetchTime?: T

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

The timestamp of when this document should be fetched next (milliseconds since epoch)

notificationType?

optional notificationType?: string

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

Type of the doc / purpose

numRetries

numRetries: T

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

The number of times this metadata has been tried to be fetched but failed

pending?

optional pending?: boolean

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

Whether this document is pending to be fetched or not

recipientAddress?

optional recipientAddress?: string

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

refreshRequestTime

refreshRequestTime: T

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

The timestamp of when this metadata was requested to be refreshed (milliseconds since epoch)

uri

uri: string

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

The URI of the metadata to be fetched. If {id} is present, it will be replaced with each individual ID in tokenIds

Edit this page on GitHub