Interface: iQueueDoc<T>

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

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

---

actionConfig?#

optional actionConfig?: any

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

For use for post-claim actions

---

activityDocId?#

optional activityDocId?: string

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

---

claimInfo?#

optional claimInfo?: object

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

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:652

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:664

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:671

---

error?#

optional error?: string

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

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:694

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:678

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:660

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:654

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:666

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:675

Type of the doc / purpose

---

numRetries#

numRetries: T

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

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:668

Whether this document is pending to be fetched or not

---

queueClaimId?#

optional queueClaimId?: string

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

Identity of the worker claim for this generation.

---

queueGeneration?#

optional queueGeneration?: string

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

Identity of the current requested queue work.

---

queueLeaseUntil?#

optional queueLeaseUntil?: T

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

Expiration of the worker lease in milliseconds since epoch.

---

recipientAddress?#

optional recipientAddress?: string

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

---

refreshRequestTime#

refreshRequestTime: T

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

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:650

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