Class: DeveloperAppDoc<T>

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

Extends#

• BaseNumberTypeClass<DeveloperAppDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iDeveloperAppDoc<T>

Constructors#

Constructor#

new DeveloperAppDoc<T>(data): DeveloperAppDoc<T>

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

Parameters#

data#

iDeveloperAppDoc<T>

Returns#

DeveloperAppDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iDeveloperAppDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iDeveloperAppDoc._id

---

clientId#

clientId: string

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

The client ID of the app

Implementation of#

iDeveloperAppDoc.clientId

---

clientSecret#

clientSecret: string

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

The client secret of the app

Implementation of#

iDeveloperAppDoc.clientSecret

---

createdAt?#

optional createdAt?: T

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

The time the app was created

Implementation of#

iDeveloperAppDoc.createdAt

---

createdBy#

createdBy: string

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

Creator of the app

Implementation of#

iDeveloperAppDoc.createdBy

---

description#

description: string

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

The description of the app

Implementation of#

iDeveloperAppDoc.description

---

image#

image: string

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

The image of the app

Implementation of#

iDeveloperAppDoc.image

---

lastUpdated?#

optional lastUpdated?: T

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

The last updated timestamp

Implementation of#

iDeveloperAppDoc.lastUpdated

---

managedBy#

managedBy: string

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

The BitBadges address of the user who is currently managing this

Implementation of#

iDeveloperAppDoc.managedBy

---

name#

name: string

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

The name of the app

Implementation of#

iDeveloperAppDoc.name

---

redirectUris#

redirectUris: string[]

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

The redirect URI of the app

Implementation of#

iDeveloperAppDoc.redirectUris

Methods#

clone()#

clone(): DeveloperAppDoc<T>

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

Deep copies the object and returns a new instance.

Returns#

DeveloperAppDoc<T>

Overrides#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): DeveloperAppDoc<U>

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

DeveloperAppDoc<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

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

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

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

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString