Class OffChainBalancesMetadataTimeline<T>

OffChainBalancesMetadataTimeline represents the value of the off-chain balances metadata over time

Index

Constructors

constructor

Properties

offChainBalancesMetadata timelineTimes

Methods

clone convert equals getNumberFieldNames toJson toJsonString toProto fromJson fromJsonString fromProto validateUpdate

Constructors

constructor

new OffChainBalancesMetadataTimeline<T>(offChainBalancesMetadataTimeline): OffChainBalancesMetadataTimeline<T>
Type Parameters
- T extends NumberType
Parameters
- offChainBalancesMetadataTimeline: iOffChainBalancesMetadataTimeline<T>
Returns OffChainBalancesMetadataTimeline<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:968

Properties

offChainBalancesMetadata

offChainBalancesMetadata: OffChainBalancesMetadata

The off-chain balances metadata.

timelineTimes

timelineTimes: UintRangeArray<T>

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

Methods

clone

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

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

convert

convert(convertFunction): OffChainBalancesMetadataTimeline
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
Returns OffChainBalancesMetadataTimeline
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:974

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

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

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

`Static`validateUpdate

validateUpdate<T>(oldOffChainBalancesMetadata, newOffChainBalancesMetadata, canUpdateOffChainBalancesMetadata): null | Error
Wrapper for validateOffChainBalancesMetadataUpdate
Type Parameters
- T extends NumberType
Parameters
- oldOffChainBalancesMetadata: OffChainBalancesMetadataTimeline<T>[]
- newOffChainBalancesMetadata: OffChainBalancesMetadataTimeline<T>[]
- canUpdateOffChainBalancesMetadata: TimedUpdatePermission<T>[]
Returns null | Error
- Defined in src/core/misc.ts:1023

Class OffChainBalancesMetadataTimeline<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OffChainBalancesMetadataTimeline<T>

Properties

offChainBalancesMetadata

timelineTimes

Methods

clone

Returns OffChainBalancesMetadataTimeline<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns OffChainBalancesMetadataTimeline<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.OffChainBalancesMetadataTimeline

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns OffChainBalancesMetadataTimeline<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns OffChainBalancesMetadataTimeline<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns OffChainBalancesMetadataTimeline<U>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`validateUpdate