Class ActionPermission<T>

ActionPermission represents a standard permission with no extra criteria.

Index

Constructors

constructor

Properties

permanentlyForbiddenTimes permanentlyPermittedTimes

Methods

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

Constructors

constructor

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

Properties

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

clone

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

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

convert

convert(convertFunction): ActionPermission
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 ActionPermission
Overrides BaseNumberTypeClass.convert
- Defined in src/core/permissions.ts:494

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.ActionPermission
Returns proto.badges.ActionPermission
- Defined in src/core/permissions.ts:503

`Static` check

check<T>(permissions, time?): null | Error
Type Parameters
- T extends NumberType
Parameters
- permissions: ActionPermission<T>[]
- Optional time: T
Returns null | Error
- Defined in src/core/permissions.ts:544

`Static` fromJson

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

`Static` fromJsonString

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

`Static` fromProto

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

`Static` validateUpdate

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

Class ActionPermission<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActionPermission<T>

Properties

permanentlyForbiddenTimes

permanentlyPermittedTimes

Methods

castToUniversalPermission

Returns UniversalPermission

clone

Returns ActionPermission<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns ActionPermission<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.ActionPermission

Static check

Type Parameters

Parameters

Returns null | Error

Static fromJson

Type Parameters

Parameters

Parameters

Returns U

Returns ActionPermission<U>

Static fromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns ActionPermission<U>

Static fromProto

Type Parameters

Parameters

Parameters

Returns U

Returns ActionPermission<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