Class: ApprovalIdentifierDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:237

ApprovalIdentifierDetails is used to represent an exact approval.

Extends#

• BaseNumberTypeClass<ApprovalIdentifierDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iApprovalIdentifierDetails<T>

Constructors#

Constructor#

new ApprovalIdentifierDetails<T>(approvalIdDetails): ApprovalIdentifierDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:245

Parameters#

approvalIdDetails#

iApprovalIdentifierDetails<T>

Returns#

ApprovalIdentifierDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

approvalId#

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:241

The approval ID of the approval.

Implementation of#

iApprovalIdentifierDetails.approvalId

---

approvalLevel#

approvalLevel: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:242

The approval level of the approval "collection", "incoming", or "outgoing".

Implementation of#

iApprovalIdentifierDetails.approvalLevel

---

approverAddress#

approverAddress: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:243

The address of the approval to check. If approvalLevel is "collection", this is blank "".

Implementation of#

iApprovalIdentifierDetails.approverAddress

---

version#

version: T

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:244

The version of the approval.

Implementation of#

iApprovalIdentifierDetails.version

Methods#

clone()#

clone(): ApprovalIdentifierDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:270

Deep copies the object and returns a new instance.

Returns#

ApprovalIdentifierDetails<T>

Overrides#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): CustomType<any>

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Inherited from#

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/core/misc.ts:253

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

---

toBech32Addresses()#

toBech32Addresses(prefix): ApprovalIdentifierDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:302

Parameters#

prefix#

string

Returns#

ApprovalIdentifierDetails<T>

---

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

---

toProto()#

toProto(): ApprovalIdentifierDetails

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:266

Returns#

ApprovalIdentifierDetails

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): ApprovalIdentifierDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:274

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

ApprovalIdentifierDetails<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): ApprovalIdentifierDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:282

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

ApprovalIdentifierDetails<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): ApprovalIdentifierDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:290

Type Parameters#

U#

U extends NumberType

Parameters#

item#

ApprovalIdentifierDetails

convertFunction#

(item) => U

Returns#

ApprovalIdentifierDetails<U>

---

required()#

static required(): ApprovalIdentifierDetails<NumberType>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:257

Returns#

ApprovalIdentifierDetails<NumberType>