Class BasicTokenDefinition

Each ITokenResolver implementation needs to define a type for its token definition, and that type should a subclass of this.

Inheritance
object
BasicTokenDefinition
AdHocToken
DynamicGameStateToken
GameClientTokenDefinition
GameClientTokenDefinitionParsed
Implements
Inherited Members
Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure.Token
Assembly: Aruba.Infrastructure.dll
Syntax
public class BasicTokenDefinition : IEquatable<BasicTokenDefinition>

Constructors

View Source

BasicTokenDefinition(BasicTokenDefinition)

Initializes a new instance of the BasicTokenDefinition class.

Declaration
protected BasicTokenDefinition(BasicTokenDefinition other)
Parameters
Type Name Description
BasicTokenDefinition other

The instance to copy.
View Source

BasicTokenDefinition(string, string)

Initializes a new instance of the BasicTokenDefinition class.

Declaration
public BasicTokenDefinition(string name, string description)
Parameters
Type Name Description
string name

The name of the token.
string description

The description of the token.

Properties

View Source

TokenDescription

Gets or sets a description that can help with the token's usage.

Declaration
public string TokenDescription { get; set; }
Property Value
Type Description
string
View Source

TokenName

Gets or sets the name of the token, as seen in a reference to it.

Declaration
public string TokenName { get; set; }
Property Value
Type Description
string

Methods

View Source

CopyNameAndDescriptionFrom(BasicTokenDefinition)

Copy the name and description to this instance.

Declaration
public void CopyNameAndDescriptionFrom(BasicTokenDefinition other)
Parameters
Type Name Description
BasicTokenDefinition other

The other instance to copy.
View Source

CopyValuesFrom(BasicTokenDefinition)

Copies the values to this instance.

Declaration
public virtual void CopyValuesFrom(BasicTokenDefinition other)
Parameters
Type Name Description
BasicTokenDefinition other

The other instance to copy.
View Source

Equals(BasicTokenDefinition)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(BasicTokenDefinition other)
Parameters
Type Name Description
BasicTokenDefinition other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements