Class: PermissionCriteria

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:14

PermissionCriteria defines the criteria for executing a permission. Currently supports approved addresses (whitelist).

Extends#

• BaseNumberTypeClass<PermissionCriteria>

Implements#

• iPermissionCriteria

Constructors#

Constructor#

new PermissionCriteria(data): PermissionCriteria

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:17

Parameters#

data#

iPermissionCriteria

Returns#

PermissionCriteria

Overrides#

BaseNumberTypeClass.constructor

Properties#

approvedAddresses#

approvedAddresses: string[]

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:15

List of approved addresses that can execute this permission.

Implementation of#

iPermissionCriteria.approvedAddresses

Methods#

clone()#

clone(): PermissionCriteria

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

Deep copies the object and returns a new instance.

Returns#

PermissionCriteria

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:26

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PermissionCriteria

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/core/managersplitter.ts:22

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

Returns#

string[]

Overrides#

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

---

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

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:30

Returns#

PermissionCriteria

---

fromJson()#

static fromJson(jsonValue, options?): PermissionCriteria

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

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

PermissionCriteria

---

fromJsonString()#

static fromJsonString(jsonString, options?): PermissionCriteria

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:40

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

PermissionCriteria

---

fromProto()#

static fromProto(protoMsg): PermissionCriteria

Defined in: packages/bitbadgesjs-sdk/src/core/managersplitter.ts:44

Parameters#

protoMsg#

PermissionCriteria

Returns#

PermissionCriteria