Class BadgeIdsActionPermission<T>

BadgeIdsActionPermission represents a permission that allows updating a balances action.

Index

Constructors

constructor

Properties

badgeIds permanentlyForbiddenTimes permanentlyPermittedTimes

Methods

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

Constructors

constructor

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

Properties

badgeIds

badgeIds: UintRangeArray<T>

The badge IDs that the permission applies to.

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:737

clone

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

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

convert

convert(convertFunction, options?): BadgeIdsActionPermission
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns BadgeIdsActionPermission
Overrides BaseNumberTypeClass.convert
- Defined in src/core/permissions.ts:696

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
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

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:127

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

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:109

toJsonString

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

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

toProto

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

`Static`check

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

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

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

`Static`validateUpdate

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

Class BadgeIdsActionPermission<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BadgeIdsActionPermission<T>

Properties

badgeIds

permanentlyForbiddenTimes

permanentlyPermittedTimes

Methods

castToUniversalPermission

Returns UniversalPermission

clone

Returns BadgeIdsActionPermission<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeIdsActionPermission<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.BadgeIdsActionPermission

Staticcheck

Type Parameters

Parameters

Returns null | Error

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeIdsActionPermission<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeIdsActionPermission<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeIdsActionPermission<U>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`check

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`validateUpdate