Olympe SDK

Class: IncrementalID

IncrementalID

Unique (incremented) identifier generator. Note: if you just need a unique string identifier, prefer the use of the olympe.utils.IncrementalID.createIdAsString method.

new IncrementalID( [id])

Parameters:
Name Type Argument Description
id number <optional>

optional only if we want to reconstruct existing ID
Deprecated:
  • use of the olympe.utils.IncrementalID.createIdAsString method

Methods

<static> createIdAsString()

Gets a new unique identifier as a string. Note: this method has been created in order to avoid the creation and immediate destruction of an IncrementalID object when a string identifier is needed.

Returns:
Type
string

<static> FromJSON( [id])

Parameters:
Name Type Argument Description
id number <optional>
Returns:
Type
olympe.utils.IncrementalID

equals(otherIncrementalID)

Parameters:
Name Type Description
otherIncrementalID olympe.utils.IncrementalID
Returns:
Type
boolean

getIdAsNumber()

Returns:
Type
number

print()

Returns:
Type
string

toJSON()

Returns:
Type
string

toString()

Returns:
Type
string