Class BalancesActionPermission<T>

BalancesActionPermission represents a permission that allows updating a balances action.

Index

Constructors

constructor

Properties

badgeIds ownershipTimes permanentlyForbiddenTimes permanentlyPermittedTimes

Methods

castToUniversalPermission clone convert equals getNumberFieldNames toJson toJsonString toProto check fromJson fromJsonString fromProto validateUpdate

Constructors

constructor

new BalancesActionPermission<T>(msg): BalancesActionPermission<T>
Type Parameters
- T extends NumberType
Parameters
- msg: iBalancesActionPermission<T>
Returns BalancesActionPermission<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/permissions.ts:690

Properties

badgeIds

badgeIds: UintRangeArray<T>

The badge IDs that the permission applies to.

ownershipTimes

ownershipTimes: UintRangeArray<T>

The owned times of the permission.

permanentlyForbiddenTimes

permanentlyForbiddenTimes: UintRangeArray<T>

The forbidden times of the permission.

permanentlyPermittedTimes

permanentlyPermittedTimes: UintRangeArray<T>

The permitted times of the permission.

Methods

castToUniversalPermission

castToUniversalPermission(): UniversalPermission
Returns UniversalPermission
- Defined in src/core/permissions.ts:741

clone

clone(): BalancesActionPermission<T>
Deep copies the object and returns a new instance.

Returns BalancesActionPermission<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:100

convert

convert(convertFunction): BalancesActionPermission
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns BalancesActionPermission
Overrides BaseNumberTypeClass.convert
- Defined in src/core/permissions.ts:698

equals

equals(other, normalizeNumberTypes?): boolean
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 extends CustomType
Parameters
- other: undefined | null | CustomType
- Optional normalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:96

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:106

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:88

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:92

toProto

toProto(): proto.badges.BalancesActionPermission
Returns proto.badges.BalancesActionPermission
- Defined in src/core/permissions.ts:709

`Static` check

check(details, permissions, time?): null | Error
Type Parameters
- U extends NumberType
Parameters
- details: {
 badgeIds: UintRangeArray;
 ownershipTimes: UintRangeArray;
 }[]
- permissions: BalancesActionPermission[]
- Optional time: U
Returns null | Error
- Defined in src/core/permissions.ts:762

`Static` fromJson

fromJson(jsonValue, convertFunction, options?): BalancesActionPermission
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optional options: Partial<JsonReadOptions>
Returns BalancesActionPermission
- Defined in src/core/permissions.ts:713

`Static` fromJsonString

fromJsonString(jsonString, convertFunction, options?): BalancesActionPermission
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optional options: Partial<JsonReadOptions>
Returns BalancesActionPermission
- Defined in src/core/permissions.ts:721

`Static` fromProto

fromProto(protoMsg, convertFunction): BalancesActionPermission
Type Parameters
- U extends NumberType
Parameters
- protoMsg: proto.badges.BalancesActionPermission
- convertFunction: ((item) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns BalancesActionPermission
- Defined in src/core/permissions.ts:729

`Static` validateUpdate

validateUpdate(permissions, newPermission): null | Error
Type Parameters
- U extends NumberType
Parameters
- permissions: BalancesActionPermission[]
- newPermission: BalancesActionPermission[]
Returns null | Error
- Defined in src/core/permissions.ts:753

Class BalancesActionPermission<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BalancesActionPermission<T>

Properties

badgeIds

ownershipTimes

permanentlyForbiddenTimes

permanentlyPermittedTimes

Methods

castToUniversalPermission

Returns UniversalPermission

clone

Returns BalancesActionPermission<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BalancesActionPermission<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.BalancesActionPermission

Static check

Type Parameters

Parameters

Returns null | Error

Static fromJson

Type Parameters

Parameters

Parameters

Returns U

Returns BalancesActionPermission<U>

Static fromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns BalancesActionPermission<U>

Static fromProto

Type Parameters

Parameters

Parameters

Returns U

Returns BalancesActionPermission<U>

Static validateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

Member Visibility

Theme

On This Page

`Static` check

`Static` fromJson

`Static` fromJsonString

`Static` fromProto

`Static` validateUpdate