Class: UserIncomingApprovalPermissionWithDetails<T>

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

Extends#

• UserIncomingApprovalPermission<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iUserIncomingApprovalPermissionWithDetails<T>
• CustomType<UserIncomingApprovalPermissionWithDetails<T>>

Constructors#

Constructor#

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

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

Parameters#

data#

iUserIncomingApprovalPermissionWithDetails<T>

Returns#

UserIncomingApprovalPermissionWithDetails<T>

Overrides#

UserIncomingApprovalPermission.constructor

Properties#

approvalId#

approvalId: string

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

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

Implementation of#

iUserIncomingApprovalPermissionWithDetails.approvalId

Inherited from#

UserIncomingApprovalPermission.approvalId

---

fromList#

fromList: AddressList

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

Implementation of#

iUserIncomingApprovalPermissionWithDetails.fromList

---

fromListId#

fromListId: string

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

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

Implementation of#

iUserIncomingApprovalPermissionWithDetails.fromListId

Inherited from#

UserIncomingApprovalPermission.fromListId

---

initiatedByList#

initiatedByList: AddressList

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

Implementation of#

iUserIncomingApprovalPermissionWithDetails.initiatedByList

---

initiatedByListId#

initiatedByListId: string

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

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

Implementation of#

iUserIncomingApprovalPermissionWithDetails.initiatedByListId

Inherited from#

UserIncomingApprovalPermission.initiatedByListId

---

ownershipTimes#

ownershipTimes: UintRangeArray<T>

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

The owned times of the approved incoming transfers.

Implementation of#

iUserIncomingApprovalPermissionWithDetails.ownershipTimes

Inherited from#

UserIncomingApprovalPermission.ownershipTimes

---

permanentlyForbiddenTimes#

permanentlyForbiddenTimes: UintRangeArray<T>

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

The forbidden times of the approved incoming transfers.

Implementation of#

iUserIncomingApprovalPermissionWithDetails.permanentlyForbiddenTimes

Inherited from#

UserIncomingApprovalPermission.permanentlyForbiddenTimes

---

permanentlyPermittedTimes#

permanentlyPermittedTimes: UintRangeArray<T>

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

The permitted times of the approved incoming transfers.

Implementation of#

iUserIncomingApprovalPermissionWithDetails.permanentlyPermittedTimes

Inherited from#

UserIncomingApprovalPermission.permanentlyPermittedTimes

---

tokenIds#

tokenIds: UintRangeArray<T>

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

The token IDs of the approved incoming transfers.

Implementation of#

iUserIncomingApprovalPermissionWithDetails.tokenIds

Inherited from#

UserIncomingApprovalPermission.tokenIds

---

transferTimes#

transferTimes: UintRangeArray<T>

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

The transfer times of the approved incoming transfers.

Implementation of#

iUserIncomingApprovalPermissionWithDetails.transferTimes

Inherited from#

UserIncomingApprovalPermission.transferTimes

Methods#

castToCollectionApprovalPermission()#

castToCollectionApprovalPermission(address): CollectionApprovalPermissionWithDetails<T>

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

Parameters#

address#

string

Returns#

CollectionApprovalPermissionWithDetails<T>

Overrides#

UserIncomingApprovalPermission.castToCollectionApprovalPermission

---

clone()#

clone(): UserIncomingApprovalPermissionWithDetails<T>

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

Deep copies the object and returns a new instance.

Returns#

UserIncomingApprovalPermissionWithDetails<T>

Implementation of#

CustomType.clone

Overrides#

UserIncomingApprovalPermission.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserIncomingApprovalPermissionWithDetails<U>

Implementation of#

CustomType.convert

Overrides#

UserIncomingApprovalPermission.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#

UserIncomingApprovalPermission.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#

UserIncomingApprovalPermission.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#

UserIncomingApprovalPermission.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): UserIncomingApprovalPermission<T>

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

Parameters#

prefix#

string

Returns#

UserIncomingApprovalPermission<T>

Inherited from#

UserIncomingApprovalPermission.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#

UserIncomingApprovalPermission.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#

UserIncomingApprovalPermission.toJsonString

---

toProto()#

toProto(): UserIncomingApprovalPermission

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

Returns#

UserIncomingApprovalPermission

Inherited from#

UserIncomingApprovalPermission.toProto

---

check()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

details#

object[]

permissions#

UserIncomingApprovalPermissionWithDetails<U>[]

time?#

U

Returns#

Error | null

Inherited from#

UserIncomingApprovalPermission.check

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserIncomingApprovalPermission<U>

Inherited from#

UserIncomingApprovalPermission.fromJson

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserIncomingApprovalPermission<U>

Inherited from#

UserIncomingApprovalPermission.fromJsonString

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

UserIncomingApprovalPermission

convertFunction#

(item) => U

Returns#

UserIncomingApprovalPermission<U>

Inherited from#

UserIncomingApprovalPermission.fromProto

---

validateUpdate()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

permissions#

UserIncomingApprovalPermissionWithDetails<U>[]

newPermission#

UserIncomingApprovalPermissionWithDetails<U>[]

Returns#

Error | null

Inherited from#

UserIncomingApprovalPermission.validateUpdate