Class: MsgPurgeApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:17

MsgPurgeApprovals is a helper message to purge expired approvals.

Extends#

• CustomTypeClass<MsgPurgeApprovals<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iMsgPurgeApprovals<T>

Constructors#

Constructor#

new MsgPurgeApprovals<T>(msg): MsgPurgeApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:25

Parameters#

msg#

iMsgPurgeApprovals<T>

Returns#

MsgPurgeApprovals<T>

Overrides#

CustomTypeClass.constructor

Properties#

approvalsToPurge#

approvalsToPurge: ApprovalIdentifierDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:23

Specific approvals to purge. If empty, purges all applicable approvals based on other flags.

Implementation of#

iMsgPurgeApprovals.approvalsToPurge

---

approverAddress#

approverAddress: string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:21

Address of the user whose approvals to purge. If empty, defaults to creator.

Implementation of#

iMsgPurgeApprovals.approverAddress

---

collectionId#

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:19

The ID of the collection.

Implementation of#

iMsgPurgeApprovals.collectionId

---

creator#

creator: string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:18

The creator of the transaction.

Implementation of#

iMsgPurgeApprovals.creator

---

purgeCounterpartyApprovals#

purgeCounterpartyApprovals: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:22

Whether to purge counterparty approvals (approvals where the creator is the only initiator).

Implementation of#

iMsgPurgeApprovals.purgeCounterpartyApprovals

---

purgeExpired#

purgeExpired: boolean

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:20

Whether to purge expired approvals (approvals with no future valid transfer times).

Implementation of#

iMsgPurgeApprovals.purgeExpired

Methods#

clone()#

clone(): MsgPurgeApprovals

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

Deep copies the object and returns a new instance.

Returns#

MsgPurgeApprovals

Inherited from#

CustomTypeClass.clone

---

convert()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

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

Inherited from#

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

---

toBech32Addresses()#

toBech32Addresses(prefix): MsgPurgeApprovals<T>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:73

Parameters#

prefix#

string

Returns#

MsgPurgeApprovals<T>

---

toCosmWasmPayloadString()#

toCosmWasmPayloadString(): string

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:84

Returns#

string

---

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

---

toProto()#

toProto(): MsgPurgeApprovals

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:35

Returns#

MsgPurgeApprovals

---

fromJson()#

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

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:46

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgPurgeApprovals<U>

---

fromJsonString()#

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

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:54

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MsgPurgeApprovals<U>

---

fromProto()#

static fromProto<U>(protoMsg, convertFunction): MsgPurgeApprovals<U>

Defined in: packages/bitbadgesjs-sdk/src/transactions/messages/bitbadges/tokenization/msgPurgeApprovals.ts:62

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

MsgPurgeApprovals

convertFunction#

(item) => U

Returns#

MsgPurgeApprovals<U>