Class BadgeMetadataTimeline<T>

BadgeMetadataTimeline represents the value of the badge metadata over time

Index

Constructors

constructor

Properties

badgeMetadata timelineTimes

Methods

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

Constructors

constructor

new BadgeMetadataTimeline<T>(badgeMetadataTimeline): BadgeMetadataTimeline<T>
Type Parameters
- T extends NumberType
Parameters
- badgeMetadataTimeline: iBadgeMetadataTimeline<T>
Returns BadgeMetadataTimeline<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:888

Properties

badgeMetadata

badgeMetadata: BadgeMetadata<T>[]

The badge metadata.

timelineTimes

timelineTimes: UintRangeArray<T>

The times of the timeline item. Times in a timeline cannot overlap.

Methods

clone

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

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

convert

convert(convertFunction, options?): BadgeMetadataTimeline
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 BadgeMetadataTimeline
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:901

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.BadgeMetadataTimeline
Returns proto.badges.BadgeMetadataTimeline
- Defined in src/core/misc.ts:910

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

fromProto(item, convertFunction): BadgeMetadataTimeline
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.BadgeMetadataTimeline
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns BadgeMetadataTimeline
- Defined in src/core/misc.ts:930

`Static`required

required(): BadgeMetadataTimeline<NumberType>
Returns BadgeMetadataTimeline<NumberType>
- Defined in src/core/misc.ts:894

`Static`validateUpdate

validateUpdate<T>(oldBadgeMetadata, newBadgeMetadata, canUpdateBadgeMetadata): null | Error
Wrapper for validateBadgeMetadataUpdate
Type Parameters
- T extends NumberType
Parameters
- oldBadgeMetadata: BadgeMetadataTimeline<T>[]
- newBadgeMetadata: BadgeMetadataTimeline<T>[]
- canUpdateBadgeMetadata: TimedUpdateWithBadgeIdsPermission<T>[]
Returns null | Error
- Defined in src/core/misc.ts:940

Class BadgeMetadataTimeline<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BadgeMetadataTimeline<T>

Properties

badgeMetadata

timelineTimes

Methods

clone

Returns BadgeMetadataTimeline<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadataTimeline<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.BadgeMetadataTimeline

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadataTimeline<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadataTimeline<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadataTimeline<U>

Staticrequired

Returns BadgeMetadataTimeline<NumberType>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`required

`Static`validateUpdate