Class: UserIncomingApprovalPermission<T>

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

UserIncomingApprovalPermission represents the permissions of a user and whether they can update their approved incoming transfers.

Extends#

• BaseNumberTypeClass<UserIncomingApprovalPermission<T>>

Extended by#

• UserIncomingApprovalPermissionWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iUserIncomingApprovalPermission<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iUserIncomingApprovalPermission<T>

Returns#

UserIncomingApprovalPermission<T>

Overrides#

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

iUserIncomingApprovalPermission.approvalId

---

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#

iUserIncomingApprovalPermission.fromListId

---

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#

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

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

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

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

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

iUserIncomingApprovalPermission.transferTimes

Methods#

castToCollectionApprovalPermission()#

castToCollectionApprovalPermission(address): CollectionApprovalPermission<T>

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

Parameters#

address#

string

Returns#

CollectionApprovalPermission<T>

---

clone()#

clone(): UserIncomingApprovalPermission

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

Deep copies the object and returns a new instance.

Returns#

UserIncomingApprovalPermission

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserIncomingApprovalPermission<U>

Overrides#

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/common/base.ts:157

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

Returns#

string[]

Inherited from#

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): UserIncomingApprovalPermission<T>

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

Parameters#

prefix#

string

Returns#

UserIncomingApprovalPermission<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(): UserIncomingApprovalPermission

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

Returns#

UserIncomingApprovalPermission

---

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

---

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>

---

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>

---

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>

---

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