Interface: iAddressListDoc<T>

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

Extends#

• iAddressList.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

---

addresses#

addresses: string[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:155

The addresses of the address list. If this is a tracker list, the addresses are the tracker IDs.

Inherited from#

iAddressList.addresses

---

createdBlock#

createdBlock: T

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

The block number when this list was created

---

createdBy#

createdBy: string

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

The BitBadges address of the user who created this list

Overrides#

iAddressList.createdBy

---

customData#

customData: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:170

Arbitrary custom data that can be stored. Leave blank for no custom data.

Inherited from#

iAddressList.customData

---

lastUpdated#

lastUpdated: T

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

The timestamp of when this list was last updated (milliseconds since epoch)

---

listId#

listId: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:150

The ID of the address list.

Inherited from#

iAddressList.listId

---

managedBy#

managedBy: string

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

The BitBadges address of the user who is currently managing this

---

nsfw?#

optional nsfw?: object

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

The NSFW reason if this list is NSFW

reason#

reason: string

---

reported?#

optional reported?: object

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

The reported reason if this list is reported

reason#

reason: string

---

updateHistory#

updateHistory: iUpdateHistory<T>[]

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

The update history of this list

---

uri#

uri: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:165

The URI where to fetch the address list metadata from.

Inherited from#

iAddressList.uri

---

whitelist#

whitelist: boolean

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/core.ts:160

Whether or not to include ONLY the addresses or include all EXCEPT the addresses.

Inherited from#

iAddressList.whitelist