API Docs for: 0.0.57
Show:

Variant Class

Constructor

Variant

(
  • options
)

Parameters:

  • options Object
    • [dataType= 0] DataType optional

      the variant type.

    • [arrayType= 0] VariantArrayType optional
    • [value= null] Any optional
    • [dimensions= null] UInt32 optional

      the matrix dimensions

Methods

binaryStoreSize

() Number
Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

decode_debug

()

isValid

() Boolean

verify that all object attributes values are valid according to schema

Returns:

Boolean:

stringToQualifiedName

(
  • value
)
NamespaceIndex: Number, name: String

Parameters:

  • value String

Returns:

NamespaceIndex: Number, name: String:

}

Example:

stringToQualifiedName("Hello") => {namespaceIndex: 0, name: "Hello"} stringToQualifiedName("3:Hello") => {namespaceIndex: 3, name: "Hello"}

toString

() String

Returns:

String:

Properties

arrayType

VariantArrayType

Default: 0

dataType

DataType

the variant type.

Default: 0

dimensions

UInt32

the matrix dimensions

Default: null

expired

Boolean - True if the security token has expired.

value

Any

Default: null