Class: UserOutgoingApprovalPermissionWithDetails<T>

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

Extends#

• UserOutgoingApprovalPermission<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iUserOutgoingApprovalPermissionWithDetails<T>
• CustomType<UserOutgoingApprovalPermissionWithDetails<T>>

Constructors#

Constructor#

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

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

Parameters#

data#

iUserOutgoingApprovalPermissionWithDetails<T>

Returns#

UserOutgoingApprovalPermissionWithDetails<T>

Overrides#

UserOutgoingApprovalPermission.constructor

Properties#

approvalId#

approvalId: string

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

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

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.approvalId

Inherited from#

UserOutgoingApprovalPermission.approvalId

---

initiatedByList#

initiatedByList: AddressList

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

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.initiatedByList

---

initiatedByListId#

initiatedByListId: string

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

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

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.initiatedByListId

Inherited from#

UserOutgoingApprovalPermission.initiatedByListId

---

ownershipTimes#

ownershipTimes: UintRangeArray<T>

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

The owned times of the approved outgoing transfers.

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.ownershipTimes

Inherited from#

UserOutgoingApprovalPermission.ownershipTimes

---

permanentlyForbiddenTimes#

permanentlyForbiddenTimes: UintRangeArray<T>

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

The forbidden times of the approved outgoing transfers.

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.permanentlyForbiddenTimes

Inherited from#

UserOutgoingApprovalPermission.permanentlyForbiddenTimes

---

permanentlyPermittedTimes#

permanentlyPermittedTimes: UintRangeArray<T>

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

The permitted times of the approved outgoing transfers.

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.permanentlyPermittedTimes

Inherited from#

UserOutgoingApprovalPermission.permanentlyPermittedTimes

---

tokenIds#

tokenIds: UintRangeArray<T>

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

The token IDs of the approved outgoing transfers.

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.tokenIds

Inherited from#

UserOutgoingApprovalPermission.tokenIds

---

toList#

toList: AddressList

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

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.toList

---

toListId#

toListId: string

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

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

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.toListId

Inherited from#

UserOutgoingApprovalPermission.toListId

---

transferTimes#

transferTimes: UintRangeArray<T>

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

The transfer times of the approved outgoing transfers.

Implementation of#

iUserOutgoingApprovalPermissionWithDetails.transferTimes

Inherited from#

UserOutgoingApprovalPermission.transferTimes

Methods#

castToCollectionApprovalPermission()#

castToCollectionApprovalPermission(address): CollectionApprovalPermissionWithDetails<T>

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

Parameters#

address#

string

Returns#

CollectionApprovalPermissionWithDetails<T>

Overrides#

UserOutgoingApprovalPermission.castToCollectionApprovalPermission

---

clone()#

clone(): UserOutgoingApprovalPermissionWithDetails<T>

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

Deep copies the object and returns a new instance.

Returns#

UserOutgoingApprovalPermissionWithDetails<T>

Implementation of#

CustomType.clone

Overrides#

UserOutgoingApprovalPermission.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserOutgoingApprovalPermissionWithDetails<U>

Implementation of#

CustomType.convert

Overrides#

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

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

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

UserOutgoingApprovalPermission.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): UserOutgoingApprovalPermission<T>

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

Parameters#

prefix#

string

Returns#

UserOutgoingApprovalPermission<T>

Inherited from#

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

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

UserOutgoingApprovalPermission.toJsonString

---

toProto()#

toProto(): UserOutgoingApprovalPermission

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

Returns#

UserOutgoingApprovalPermission

Inherited from#

UserOutgoingApprovalPermission.toProto

---

check()#

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

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

Checks if a certain approvals can be updated based on the permissions.

Type Parameters#

U#

U extends NumberType

Parameters#

details#

object[]

permissions#

UserOutgoingApprovalPermissionWithDetails<U>[]

time?#

U

Returns#

Error | null

Inherited from#

UserOutgoingApprovalPermission.check

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserOutgoingApprovalPermission<U>

Inherited from#

UserOutgoingApprovalPermission.fromJson

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserOutgoingApprovalPermission<U>

Inherited from#

UserOutgoingApprovalPermission.fromJsonString

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

UserOutgoingApprovalPermission

convertFunction#

(item) => U

Returns#

UserOutgoingApprovalPermission<U>

Inherited from#

UserOutgoingApprovalPermission.fromProto

---

validateUpdate()#

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

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

Validates the update of the user outgoing approval permissions from old to new. No permanently frozen times can be edited.

Type Parameters#

U#

U extends NumberType

Parameters#

permissions#

UserOutgoingApprovalPermissionWithDetails<U>[]

newPermission#

UserOutgoingApprovalPermissionWithDetails<U>[]

Returns#

Error | null

Inherited from#

UserOutgoingApprovalPermission.validateUpdate