TokenDefinitionData Class

The data transfer object for a parameter token coming from JSON, represents a TokenDefinition, and derived types, such as TimeToken and BasicToken.

Inheritance Hierarchy

SystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsTokenDefinitionData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.4.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class TokenDefinitionData : BaseDataContract

<DataContractAttribute>
Public Class TokenDefinitionData
	Inherits BaseDataContract

[DataContractAttribute]
public ref class TokenDefinitionData : public BaseDataContract

[<DataContractAttribute>]
type TokenDefinitionData =  
    class
        inherit BaseDataContract
    end

The TokenDefinitionData type exposes the following members.

Constructors

	Name	Description
	TokenDefinitionData	Initializes a new instance of the TokenDefinitionData class.

Top

Properties

	Name	Description
	AccountId	Gets the ID of the account associated with the token.
	Caption	Gets the caption, in the culture of the caller if possible.
	Category	Gets the token category.
	CreatedBy	Gets the user account ID that created the token.
	CreatedTime	Gets the created timestamp value.
	DataCategory	The data rule category.
	DataCubeId	The data cube ID that exposes the source element.
	DataElement	The source element unique name.
	DataType	Gets the token data type.
	DefaultCaption	Gets or sets the default caption for the token definition. Note: This returns the CultureInfo.InvariantCulture token caption, not the culture specific caption.
	DisplayType	Gets the token display type.
	EndMemberGranularity	Gets or sets the granularity of the end member (only for full range tokens).
	EndMemberOffset	Gets or sets the offset for the end member (only for full range tokens).
	FormatOverride	Gets or sets the format override, when applicable.
	Hierarchy	Gets the hierarchy.
	Id	Gets the token definition ID.
	IsInversionSupported	Gets a value indicating whether this token supports inversion.
	IsOffsetSupported	Gets or sets a value indicating whether this token supports offset.
	IsResolvable	Gets a value indicating whether this token can be resolved.
	MemberGranularity	Gets or sets the granularity of the start (or single) member.
	MemberOffset	Gets or sets the initial date/time offset for the start (or single) member.
	ProjectId	Gets the project ID for which the token is active.
	Selection	Gets or sets the member selection.
	Statement	Gets or sets the script text.
	StatementType	Gets the type of the script statement.
	Symbol	Gets or sets the symbol.
	TenantId	Gets the ID of the tenant associated with the token.
	UIClassName	Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
	UpdatedBy	Gets the user account ID that performed the last update.
	UpdatedTime	Gets the last update timestamp value.

Top

Methods

	Name	Description
	FromDataContractMappings	The mapping between TokenDefinitionData and TokenDefinition.
	ToDataContractMappings	The mapping between TokenDefinition and TokenDefinitionData.

Top

Extension Methods

	Name	Description
	SetUIClassName	Sets the name of the token definition UI class. (Defined by ModelDataExtensions.)

Top

Reference

Dundas.BI.WebApi.Models Namespace