Class: AccessTokenDoc

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

Extends#

• CustomTypeClass<AccessTokenDoc>

Implements#

• iAccessTokenDoc

Constructors#

Constructor#

new AccessTokenDoc(data): AccessTokenDoc

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

Parameters#

data#

iAccessTokenDoc

Returns#

AccessTokenDoc

Overrides#

CustomTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iAccessTokenDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iAccessTokenDoc._id

---

accessToken#

accessToken: string

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

Implementation of#

iAccessTokenDoc.accessToken

---

accessTokenExpiresAt#

accessTokenExpiresAt: number

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

Implementation of#

iAccessTokenDoc.accessTokenExpiresAt

---

address#

address: string

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

Implementation of#

iAccessTokenDoc.address

---

bitbadgesAddress#

bitbadgesAddress: string

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

Implementation of#

iAccessTokenDoc.bitbadgesAddress

---

clientId#

clientId: string

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

Implementation of#

iAccessTokenDoc.clientId

---

refreshToken#

refreshToken: string

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

Implementation of#

iAccessTokenDoc.refreshToken

---

refreshTokenExpiresAt#

refreshTokenExpiresAt: number

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

Implementation of#

iAccessTokenDoc.refreshTokenExpiresAt

---

scopes#

scopes: OAuthScopeDetails[]

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

Implementation of#

iAccessTokenDoc.scopes

---

tokenType#

tokenType: string

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

Implementation of#

iAccessTokenDoc.tokenType

Methods#

clone()#

clone(): AccessTokenDoc

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

Deep copies the object and returns a new instance.

Returns#

AccessTokenDoc

Overrides#

CustomTypeClass.clone

---

convert()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

AccessTokenDoc

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Overrides#

CustomTypeClass.convert

---

equals()#

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

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

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

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString