Class: CollectionApprovalPermissionWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:904

Extends#

• CollectionApprovalPermission<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionApprovalPermissionWithDetails<T>
• CustomType<CollectionApprovalPermissionWithDetails<T>>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:912

Parameters#

data#

iCollectionApprovalPermissionWithDetails<T>

Returns#

CollectionApprovalPermissionWithDetails<T>

Overrides#

CollectionApprovalPermission.constructor

Properties#

approvalId#

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:772

The approval ID of the approved transfers. Can use "All" to represent all IDs, "!approvalId" to represent all IDs except approvalId, or "approvalId" to represent only approvalId.

Implementation of#

iCollectionApprovalPermissionWithDetails.approvalId

Inherited from#

CollectionApprovalPermission.approvalId

---

fromList#

fromList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:909

Implementation of#

iCollectionApprovalPermissionWithDetails.fromList

---

fromListId#

fromListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:766

The list ID of the from addresses of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.fromListId

Inherited from#

CollectionApprovalPermission.fromListId

---

initiatedByList#

initiatedByList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:910

Implementation of#

iCollectionApprovalPermissionWithDetails.initiatedByList

---

initiatedByListId#

initiatedByListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:768

The list ID of the initiatedBy addresses of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.initiatedByListId

Inherited from#

CollectionApprovalPermission.initiatedByListId

---

ownershipTimes#

ownershipTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:771

The owned times of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.ownershipTimes

Inherited from#

CollectionApprovalPermission.ownershipTimes

---

permanentlyForbiddenTimes#

permanentlyForbiddenTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:774

The forbidden times of this permission.

Implementation of#

iCollectionApprovalPermissionWithDetails.permanentlyForbiddenTimes

Inherited from#

CollectionApprovalPermission.permanentlyForbiddenTimes

---

permanentlyPermittedTimes#

permanentlyPermittedTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:773

The permitted times of this permission.

Implementation of#

iCollectionApprovalPermissionWithDetails.permanentlyPermittedTimes

Inherited from#

CollectionApprovalPermission.permanentlyPermittedTimes

---

tokenIds#

tokenIds: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:770

The token IDs of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.tokenIds

Inherited from#

CollectionApprovalPermission.tokenIds

---

toList#

toList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:908

Implementation of#

iCollectionApprovalPermissionWithDetails.toList

---

toListId#

toListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:767

The list ID of the to addresses of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.toListId

Inherited from#

CollectionApprovalPermission.toListId

---

transferTimes#

transferTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:769

The transfer times of the approved transfers.

Implementation of#

iCollectionApprovalPermissionWithDetails.transferTimes

Inherited from#

CollectionApprovalPermission.transferTimes

Methods#

castToUniversalPermission()#

castToUniversalPermission(): UniversalPermission

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:927

Returns#

UniversalPermission

---

clone()#

clone(): CollectionApprovalPermissionWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:919

Deep copies the object and returns a new instance.

Returns#

CollectionApprovalPermissionWithDetails<T>

Implementation of#

CustomType.clone

Overrides#

CollectionApprovalPermission.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:923

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionApprovalPermissionWithDetails<U>

Implementation of#

CustomType.convert

Overrides#

CollectionApprovalPermission.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

Implementation of#

CustomType.equals

Inherited from#

CollectionApprovalPermission.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Implementation of#

CustomType.getNumberFieldNames

Inherited from#

CollectionApprovalPermission.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Implementation of#

CustomType.hasNumberFields

Inherited from#

CollectionApprovalPermission.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): CollectionApprovalPermission<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:889

Parameters#

prefix#

string

Returns#

CollectionApprovalPermission<T>

Inherited from#

CollectionApprovalPermission.toBech32Addresses

---

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

Implementation of#

CustomType.toJson

Inherited from#

CollectionApprovalPermission.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Implementation of#

CustomType.toJsonString

Inherited from#

CollectionApprovalPermission.toJsonString

---

toProto()#

toProto(): CollectionApprovalPermission

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:805

Returns#

CollectionApprovalPermission

Inherited from#

CollectionApprovalPermission.toProto

---

check()#

static check<U>(details, permissions, time?): Error | null

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:851

Type Parameters#

U#

U extends NumberType

Parameters#

details#

object[]

permissions#

CollectionApprovalPermissionWithDetails<U>[]

time?#

U

Returns#

Error | null

Inherited from#

CollectionApprovalPermission.check

---

fromJson()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:809

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionApprovalPermission<U>

Inherited from#

CollectionApprovalPermission.fromJson

---

fromJsonString()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:817

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionApprovalPermission<U>

Inherited from#

CollectionApprovalPermission.fromJsonString

---

fromProto()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:825

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

CollectionApprovalPermission

convertFunction#

(item) => U

Returns#

CollectionApprovalPermission<U>

Inherited from#

CollectionApprovalPermission.fromProto

---

validateUpdate()#

static validateUpdate<U>(permissions, newPermission): Error | null

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:842

Type Parameters#

U#

U extends NumberType

Parameters#

permissions#

CollectionApprovalPermissionWithDetails<U>[]

newPermission#

CollectionApprovalPermissionWithDetails<U>[]

Returns#

Error | null

Inherited from#

CollectionApprovalPermission.validateUpdate