TokenService.resolveToken Method

Resolves the given token to the string representation.
 

Parameters

tokenId

Type: String
The ID of the token to resolve.
offset

Type: Number
(optional) The offset to use when resolving.
Optional: True
displayTypes

Type: TokenDisplayTypes
(optional) The display types to use for resolving the token.
Optional: True
hierarchyEntityId

Type: String
(optional) The ID of the time dimension to use to format the text for the token. If specified, then the hierarchyUniqueName must also be specified.
Optional: True
hierarchyUniqueName

Type: String
(optional) The hierarchy unique name of the hierarchy within the time dimension to use to format the text. Must be specified if hierarchyEntityId is specified.
Optional: True

Return Value


Type: String
A promise object that is resolved when the call is complete. If successful, a String is returned.