Class: UserPermissions<T>

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

UserPermissions represents the permissions of a user and what they can update about their approvals.

Extends#

• BaseNumberTypeClass<UserPermissions<T>>

Extended by#

• UserPermissionsWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iUserPermissions<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iUserPermissions<T>

Returns#

UserPermissions<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

canUpdateAutoApproveAllIncomingTransfers#

canUpdateAutoApproveAllIncomingTransfers: ActionPermission<T>[]

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

The permissions for updating auto-approving all incoming transfers. If auto-approve is enabled, then the user will be approved by default for all incoming transfers.

Implementation of#

iUserPermissions.canUpdateAutoApproveAllIncomingTransfers

---

canUpdateAutoApproveSelfInitiatedIncomingTransfers#

canUpdateAutoApproveSelfInitiatedIncomingTransfers: ActionPermission<T>[]

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

The permissions for updating auto-approving self-initiated incoming transfers. If auto-approve is enabled, then the user will be approved by default for all incoming transfers that are self-initiated.

Implementation of#

iUserPermissions.canUpdateAutoApproveSelfInitiatedIncomingTransfers

---

canUpdateAutoApproveSelfInitiatedOutgoingTransfers#

canUpdateAutoApproveSelfInitiatedOutgoingTransfers: ActionPermission<T>[]

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

The permissions for updating auto-approving self-initiated outgoing transfers. If auto-approve is enabled, then the user will be approved by default for all outgoing transfers that are self-initiated.

Implementation of#

iUserPermissions.canUpdateAutoApproveSelfInitiatedOutgoingTransfers

---

canUpdateIncomingApprovals#

canUpdateIncomingApprovals: UserIncomingApprovalPermission<T>[]

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

The list of permissions for updating approved incoming transfers.

Implementation of#

iUserPermissions.canUpdateIncomingApprovals

---

canUpdateOutgoingApprovals#

canUpdateOutgoingApprovals: UserOutgoingApprovalPermission<T>[]

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

The list of permissions for updating approved outgoing transfers.

Implementation of#

iUserPermissions.canUpdateOutgoingApprovals

Methods#

clone()#

clone(): UserPermissions

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

Deep copies the object and returns a new instance.

Returns#

UserPermissions

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

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

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

Parameters#

prefix#

string

Returns#

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

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

Returns#

UserPermissions

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserPermissions<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserPermissions<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

UserPermissions

convertFunction#

(item) => U

Returns#

UserPermissions<U>

---

InitEmpty()#

static InitEmpty(): UserPermissions<bigint>

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

Returns#

UserPermissions<bigint>

---

validateUpdate()#

static validateUpdate<U>(oldPermissions, newPermissions): Error | null

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

Validates the update of the user permissions from old to new.

Type Parameters#

U#

U extends NumberType

Parameters#

oldPermissions#

UserPermissionsWithDetails<U>

newPermissions#

UserPermissionsWithDetails<U>

Returns#

Error | null