# Class: QueueDoc\<T\>

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:597](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L597)

## Extends

- [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class)\<`QueueDoc`\<`T`\>\>

## Type Parameters

### T

`T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)

## Implements

- [`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc)\<`T`\>

## Constructors

### Constructor

> **new QueueDoc**\<`T`\>(`data`): `QueueDoc`\<`T`\>

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:628](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L628)

#### Parameters

##### data

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc)\<`T`\>

#### Returns

`QueueDoc`\<`T`\>

#### Overrides

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#constructor)

## Properties

### \_docId

> **\_docId**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:598](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L598)

A unique stringified document ID

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#_docid)

***

### \_id?

> `optional` **\_id?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:599](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L599)

A unique document ID (Mongo DB ObjectID)

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#_id)

***

### actionConfig?

> `optional` **actionConfig?**: `any`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:625](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L625)

For use for post-claim actions

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`actionConfig`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#actionconfig)

***

### activityDocId?

> `optional` **activityDocId?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:612](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L612)

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`activityDocId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#activitydocid)

***

### claimInfo?

> `optional` **claimInfo?**: `object`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:614](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L614)

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`

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`claimInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#claiminfo)

***

### collectionId

> **collectionId**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:601](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L601)

The collection ID of the metadata to be fetched

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`collectionId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#collectionid)

***

### deletedAt?

> `optional` **deletedAt?**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:608](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L608)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`deletedAt`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#deletedat)

***

### emailMessage?

> `optional` **emailMessage?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:610](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L610)

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`emailMessage`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#emailmessage)

***

### error?

> `optional` **error?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:607](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L607)

The error message if this metadata failed to be fetched

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`error`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#error)

***

### faucetInfo?

> `optional` **faucetInfo?**: `object`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:624](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L624)

For use for airdrops

#### amount

> **amount**: [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)

#### denom

> **denom**: `string`

#### recipient

> **recipient**: `string`

#### txHash

> **txHash**: `string`

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`faucetInfo`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#faucetinfo)

***

### initiatedBy?

> `optional` **initiatedBy?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:626](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L626)

The BitBadges address of the user who initiated this fetch

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`initiatedBy`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#initiatedby)

***

### lastFetchedAt?

> `optional` **lastFetchedAt?**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:606](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L606)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`lastFetchedAt`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#lastfetchedat)

***

### loadBalanceId

> **loadBalanceId**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:602](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L602)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`loadBalanceId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#loadbalanceid)

***

### nextFetchTime?

> `optional` **nextFetchTime?**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:609](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L609)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`nextFetchTime`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#nextfetchtime)

***

### notificationType?

> `optional` **notificationType?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:613](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L613)

Type of the doc / purpose

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`notificationType`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#notificationtype)

***

### numRetries

> **numRetries**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:605](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L605)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`numRetries`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#numretries)

***

### pending?

> `optional` **pending?**: `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:603](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L603)

Whether this document is pending to be fetched or not

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`pending`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#pending)

***

### recipientAddress?

> `optional` **recipientAddress?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:611](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L611)

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`recipientAddress`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#recipientaddress)

***

### refreshRequestTime

> **refreshRequestTime**: `T`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:604](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L604)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`refreshRequestTime`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#refreshrequesttime)

***

### uri

> **uri**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:600](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L600)

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

#### Implementation of

[`iQueueDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc).[`uri`](https://docs.bitbadges.io/sdk/reference/interfaces/i-queue-doc#uri)

## Methods

### clone()

> **clone**(): `QueueDoc`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151)

Deep copies the object and returns a new instance.

#### Returns

`QueueDoc`

#### Inherited from

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#clone)

***

### convert()

> **convert**\<`U`\>(`convertFunction`, `options?`): `QueueDoc`\<`U`\>

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:656](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L656)

Converts the object to a different NumberType equivalent.

#### Type Parameters

##### U

`U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)

#### Parameters

##### convertFunction

(`item`) => `U`

##### options?

[`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options)

#### Returns

`QueueDoc`\<`U`\>

#### Overrides

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#convert)

***

### equals()

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

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147)

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`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\>

#### Parameters

##### other

[`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined`

##### normalizeNumberTypes?

`boolean`

#### Returns

`boolean`

#### Inherited from

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#equals)

***

### getNumberFieldNames()

> **getNumberFieldNames**(): `string`[]

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:652](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L652)

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

#### Returns

`string`[]

#### Overrides

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#getnumberfieldnames)

***

### hasNumberFields()

> **hasNumberFields**(): `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161)

Checks if the object has number fields.

#### Returns

`boolean`

#### Inherited from

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#hasnumberfields)

***

### toJson()

> **toJson**(): `JsonObject`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139)

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

#### Returns

`JsonObject`

#### Inherited from

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojson)

***

### toJsonString()

> **toJsonString**(): `string`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143)

Converts the object to a JSON string.

#### Returns

`string`

#### Inherited from

[`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojsonstring)