Neuron®
The Neuron® is the basis for the creation of open and secure federated networks for smart societies.
Loading...
Searching...
No Matches
NeuroFeatures.Token Class Reference

Neuro-Feature Token More...

Public Member Functions

 Token ()
 Neuro-Feature Token More...
 
void SerializeUniqueContent (StringBuilder Xml)
 Serializes the content of Token that uniqueness is determined from, in normalized form. More...
 
Guid ComputeUniqueGuid ()
 Computes a GUID from the defining contents of the token. More...
 
string ToXml ()
 Exports the token to XML. More...
 
void Serialize (StringBuilder Xml)
 Serializes the Token, in normalized form. More...
 
void Serialize (StringBuilder Xml, bool IncludeNamespace, bool IncludeServerSignature)
 Serializes the Token, in normalized form. More...
 
Task< Layout2DDocumentGetEmbeddedLayout (Variables Variables)
 Gets the embedded layout information. More...
 
Task< SKImage > RenderEmbeddedLayout ()
 Renders the embedded layout. More...
 
async Task< SKImage > RenderEmbeddedLayout (Variables Session)
 Renders the embedded layout. More...
 
async Task< NoteCommand[]> GetNoteCommands ()
 Gets More...
 

Static Public Member Functions

static async Task< TokenTryParse (XmlElement Xml)
 Tries to parse a Token. More...
 

Properties

TokenIdMethod TokenIdMethod [get, set]
 The method used to create the Token ID. More...
 
string TokenId [get, set]
 Token ID More...
 
string ShortId [get, set]
 Short ID, if available More...
 
string MachineId [get, set]
 State Machine ID, if any More...
 
ContractVisibility Visibility [get, set]
 Token visibility More...
 
bool IsPublic [get]
 If the token is public. More...
 
string Creator [get, set]
 Creator of token More...
 
string CreatorJid [get, set]
 JID of Creator of token More...
 
string Owner [get, set]
 Current owner of token More...
 
string OwnerJid [get, set]
 JID of Current owner of token More...
 
string TrustProvider [get, set]
 Trust Provider, asserting claims in the token. More...
 
string TrustProviderJid [get, set]
 JID of Trust Provider, asserting claims in the token. More...
 
string Currency [get, set]
 Currency used to represent latest value. More...
 
string Reference [get, set]
 Link to reference information. More...
 
string Definition [get, set]
 M2M definition of token, in XML, from the original creation contract. More...
 
string DefinitionNamespace [get, set]
 Namespace of M2M definition of token. More...
 
XmlDocument DefinitionParsed [get]
 Parsed definition More...
 
string CreationContract [get, set]
 ID of contract that details the claims of the current owner More...
 
string CreationContractTemplate [get, set]
 ID of contract template that was used to create the creation contract More...
 
string OwnershipContract [get, set]
 ID of contract that details the claims of the current owner More...
 
string[] Valuator [get, set]
 Optional Legal IDs of parties used to estimate the value of the token. More...
 
string[] Assessor [get, set]
 Optional Legal IDs of assessorrs used in the construction of the token. More...
 
string[] Certifier [get, set]
 Optional Legal IDs of parties used to certify claims in the legal document used to create the token. More...
 
string[] CertifierJids [get, set]
 Optional Bare JIDs of parties used to certify claims in the legal document used to create the token. More...
 
string[] Witness [get, set]
 Optional Legal IDs of witnesses during the construction of the token. More...
 
decimal Value [get, set]
 Latest value of token More...
 
DateTime Created [get, set]
 When token was created. More...
 
DateTime Updated [get, set]
 When token was updated. More...
 
DateTime Expires [get, set]
 Expiry date of token. More...
 
DurationArchiveRequired [get, set]
 Duration after which token expires, the token is required to be archived. More...
 
DurationArchiveOptional [get, set]
 Duration after which token expires, and the required archiving time, the token can optionally be archived. More...
 
DateTime SignatureTimestamp [get, set]
 When the Trust Provider signed the contents of the token. More...
 
byte[] Signature [get, set]
 Trust Provider Signature of contents in token. More...
 
byte[] DefinitionSchemaDigest [get, set]
 Hash Digest of schema used to validate the definition of the token. More...
 
HashFunction DefinitionSchemaHashFunction [get, set]
 Hash function used to compute digest of validation schema. More...
 
bool CreatorCanDestroy [get, set]
 If the creator is allowed to destroy the token. More...
 
bool OwnerCanDestroyBatch [get, set]
 If the current owner is allowed to destroy the entire batch of tokens, if owner of all. More...
 
bool OwnerCanDestroyIndividual [get, set]
 If the current owner is allowed to destroy the token individually. More...
 
bool CertifierCanDestroy [get, set]
 If a certifier is allowed to destroy the token. More...
 
string FriendlyName [get, set]
 A friendly name for the token. More...
 
string Category [get, set]
 A category for the token. More...
 
string Description [get, set]
 Description Markdown for the token. More...
 
bool HasDescription [get]
 If the token has a description. More...
 
byte[] Glyph [get, set]
 Token glyph More...
 
string GlyphContentType [get, set]
 Content-Type of glyph More...
 
int GlyphWidth [get, set]
 Width of glyph, in pixels. More...
 
int GlyphHeight [get, set]
 Height of glyph, in pixels. More...
 
int Ordinal [get, set]
 Ordinal of token created by the creation smart contract. More...
 
int BatchSize [get, set]
 Size of the batch of contracts created. More...
 
TokenTag[] Tags [get, set]
 Token Tags More...
 
bool HasStateMachine [get]
 If the token has an associated state-machine. More...
 
bool HasEmbeddedLayout [get]
 If the token has embedded layout information. More...
 
XmlElement EmbeddedLayoutDefinition [get]
 If the token has embedded layout information. More...
 

Detailed Description

Neuro-Feature Token

Definition at line 45 of file Token.cs.

Constructor & Destructor Documentation

◆ Token()

NeuroFeatures.Token.Token ( )

Neuro-Feature Token

Definition at line 99 of file Token.cs.

Member Function Documentation

◆ ComputeUniqueGuid()

Guid NeuroFeatures.Token.ComputeUniqueGuid ( )

Computes a GUID from the defining contents of the token.

Returns
GUID

Definition at line 966 of file Token.cs.

◆ GetEmbeddedLayout()

Task< Layout2DDocument > NeuroFeatures.Token.GetEmbeddedLayout ( Variables  Variables)

Gets the embedded layout information.

Parameters
VariablesVariables
Returns
Embedded layout.
Exceptions
InvalidOperationExceptionIf no embedded layout information is available.

Definition at line 1226 of file Token.cs.

◆ GetNoteCommands()

async Task< NoteCommand[]> NeuroFeatures.Token.GetNoteCommands ( )

Gets

Returns

Definition at line 1275 of file Token.cs.

◆ RenderEmbeddedLayout() [1/2]

Task< SKImage > NeuroFeatures.Token.RenderEmbeddedLayout ( )

Renders the embedded layout.

Returns
Image

Definition at line 1238 of file Token.cs.

◆ RenderEmbeddedLayout() [2/2]

async Task< SKImage > NeuroFeatures.Token.RenderEmbeddedLayout ( Variables  Session)

Renders the embedded layout.

Parameters
SessionSession variables.
Returns
Image

Definition at line 1248 of file Token.cs.

◆ Serialize() [1/2]

void NeuroFeatures.Token.Serialize ( StringBuilder  Xml)

Serializes the Token, in normalized form.

Parameters
XmlXML Output

Definition at line 997 of file Token.cs.

◆ Serialize() [2/2]

void NeuroFeatures.Token.Serialize ( StringBuilder  Xml,
bool  IncludeNamespace,
bool  IncludeServerSignature 
)

Serializes the Token, in normalized form.

Parameters
XmlXML Output
IncludeNamespaceIf namespace attribute should be included.
IncludeServerSignatureIf the server signature should be included.

Definition at line 1008 of file Token.cs.

◆ SerializeUniqueContent()

void NeuroFeatures.Token.SerializeUniqueContent ( StringBuilder  Xml)

Serializes the content of Token that uniqueness is determined from, in normalized form.

Parameters
XmlXML Output

Definition at line 943 of file Token.cs.

◆ ToXml()

string NeuroFeatures.Token.ToXml ( )

Exports the token to XML.

Returns
XML string.

Definition at line 986 of file Token.cs.

◆ TryParse()

static async Task< Token > NeuroFeatures.Token.TryParse ( XmlElement  Xml)
static

Tries to parse a Token.

Parameters
XmlXML Definition
Returns
Parsed token, if successful, null otherwise.

Definition at line 555 of file Token.cs.

Property Documentation

◆ ArchiveOptional

Duration? NeuroFeatures.Token.ArchiveOptional
getset

Duration after which token expires, and the required archiving time, the token can optionally be archived.

Definition at line 377 of file Token.cs.

◆ ArchiveRequired

Duration? NeuroFeatures.Token.ArchiveRequired
getset

Duration after which token expires, the token is required to be archived.

Definition at line 368 of file Token.cs.

◆ Assessor

string [] NeuroFeatures.Token.Assessor
getset

Optional Legal IDs of assessorrs used in the construction of the token.

Definition at line 296 of file Token.cs.

◆ BatchSize

int NeuroFeatures.Token.BatchSize
getset

Size of the batch of contracts created.

Definition at line 535 of file Token.cs.

◆ Category

string NeuroFeatures.Token.Category
getset

A category for the token.

Definition at line 467 of file Token.cs.

◆ Certifier

string [] NeuroFeatures.Token.Certifier
getset

Optional Legal IDs of parties used to certify claims in the legal document used to create the token.

Definition at line 305 of file Token.cs.

◆ CertifierCanDestroy

bool NeuroFeatures.Token.CertifierCanDestroy
getset

If a certifier is allowed to destroy the token.

Definition at line 449 of file Token.cs.

◆ CertifierJids

string [] NeuroFeatures.Token.CertifierJids
getset

Optional Bare JIDs of parties used to certify claims in the legal document used to create the token.

Definition at line 314 of file Token.cs.

◆ Created

DateTime NeuroFeatures.Token.Created
getset

When token was created.

Definition at line 341 of file Token.cs.

◆ CreationContract

string NeuroFeatures.Token.CreationContract
getset

ID of contract that details the claims of the current owner

Definition at line 260 of file Token.cs.

◆ CreationContractTemplate

string NeuroFeatures.Token.CreationContractTemplate
getset

ID of contract template that was used to create the creation contract

Definition at line 269 of file Token.cs.

◆ Creator

string NeuroFeatures.Token.Creator
getset

Creator of token

Definition at line 158 of file Token.cs.

◆ CreatorCanDestroy

bool NeuroFeatures.Token.CreatorCanDestroy
getset

If the creator is allowed to destroy the token.

Definition at line 422 of file Token.cs.

◆ CreatorJid

string NeuroFeatures.Token.CreatorJid
getset

JID of Creator of token

Definition at line 167 of file Token.cs.

◆ Currency

string NeuroFeatures.Token.Currency
getset

Currency used to represent latest value.

Definition at line 212 of file Token.cs.

◆ Definition

string NeuroFeatures.Token.Definition
getset

M2M definition of token, in XML, from the original creation contract.

Definition at line 230 of file Token.cs.

◆ DefinitionNamespace

string NeuroFeatures.Token.DefinitionNamespace
getset

Namespace of M2M definition of token.

Definition at line 239 of file Token.cs.

◆ DefinitionParsed

XmlDocument NeuroFeatures.Token.DefinitionParsed
get

Parsed definition

Definition at line 248 of file Token.cs.

◆ DefinitionSchemaDigest

byte [] NeuroFeatures.Token.DefinitionSchemaDigest
getset

Hash Digest of schema used to validate the definition of the token.

Definition at line 404 of file Token.cs.

◆ DefinitionSchemaHashFunction

HashFunction NeuroFeatures.Token.DefinitionSchemaHashFunction
getset

Hash function used to compute digest of validation schema.

Definition at line 413 of file Token.cs.

◆ Description

string NeuroFeatures.Token.Description
getset

Description Markdown for the token.

Definition at line 476 of file Token.cs.

◆ EmbeddedLayoutDefinition

XmlElement NeuroFeatures.Token.EmbeddedLayoutDefinition
get

If the token has embedded layout information.

Definition at line 1199 of file Token.cs.

◆ Expires

DateTime NeuroFeatures.Token.Expires
getset

Expiry date of token.

Definition at line 359 of file Token.cs.

◆ FriendlyName

string NeuroFeatures.Token.FriendlyName
getset

A friendly name for the token.

Definition at line 458 of file Token.cs.

◆ Glyph

byte [] NeuroFeatures.Token.Glyph
getset

Token glyph

Definition at line 490 of file Token.cs.

◆ GlyphContentType

string NeuroFeatures.Token.GlyphContentType
getset

Content-Type of glyph

Definition at line 499 of file Token.cs.

◆ GlyphHeight

int NeuroFeatures.Token.GlyphHeight
getset

Height of glyph, in pixels.

Definition at line 517 of file Token.cs.

◆ GlyphWidth

int NeuroFeatures.Token.GlyphWidth
getset

Width of glyph, in pixels.

Definition at line 508 of file Token.cs.

◆ HasDescription

bool NeuroFeatures.Token.HasDescription
get

If the token has a description.

Definition at line 485 of file Token.cs.

◆ HasEmbeddedLayout

bool NeuroFeatures.Token.HasEmbeddedLayout
get

If the token has embedded layout information.

Definition at line 1194 of file Token.cs.

◆ HasStateMachine

bool NeuroFeatures.Token.HasStateMachine
get

If the token has an associated state-machine.

Definition at line 1181 of file Token.cs.

◆ IsPublic

bool NeuroFeatures.Token.IsPublic
get

If the token is public.

Definition at line 151 of file Token.cs.

◆ MachineId

string NeuroFeatures.Token.MachineId
getset

State Machine ID, if any

Definition at line 133 of file Token.cs.

◆ Ordinal

int NeuroFeatures.Token.Ordinal
getset

Ordinal of token created by the creation smart contract.

Definition at line 526 of file Token.cs.

◆ Owner

string NeuroFeatures.Token.Owner
getset

Current owner of token

Definition at line 176 of file Token.cs.

◆ OwnerCanDestroyBatch

bool NeuroFeatures.Token.OwnerCanDestroyBatch
getset

If the current owner is allowed to destroy the entire batch of tokens, if owner of all.

Definition at line 431 of file Token.cs.

◆ OwnerCanDestroyIndividual

bool NeuroFeatures.Token.OwnerCanDestroyIndividual
getset

If the current owner is allowed to destroy the token individually.

Definition at line 440 of file Token.cs.

◆ OwnerJid

string NeuroFeatures.Token.OwnerJid
getset

JID of Current owner of token

Definition at line 185 of file Token.cs.

◆ OwnershipContract

string NeuroFeatures.Token.OwnershipContract
getset

ID of contract that details the claims of the current owner

Definition at line 278 of file Token.cs.

◆ Reference

string NeuroFeatures.Token.Reference
getset

Link to reference information.

Definition at line 221 of file Token.cs.

◆ ShortId

string NeuroFeatures.Token.ShortId
getset

Short ID, if available

Definition at line 124 of file Token.cs.

◆ Signature

byte [] NeuroFeatures.Token.Signature
getset

Trust Provider Signature of contents in token.

Definition at line 395 of file Token.cs.

◆ SignatureTimestamp

DateTime NeuroFeatures.Token.SignatureTimestamp
getset

When the Trust Provider signed the contents of the token.

Definition at line 386 of file Token.cs.

◆ Tags

TokenTag [] NeuroFeatures.Token.Tags
getset

Token Tags

Definition at line 544 of file Token.cs.

◆ TokenId

string NeuroFeatures.Token.TokenId
getset

Token ID

Definition at line 115 of file Token.cs.

◆ TokenIdMethod

TokenIdMethod NeuroFeatures.Token.TokenIdMethod
getset

The method used to create the Token ID.

Definition at line 106 of file Token.cs.

◆ TrustProvider

string NeuroFeatures.Token.TrustProvider
getset

Trust Provider, asserting claims in the token.

Definition at line 194 of file Token.cs.

◆ TrustProviderJid

string NeuroFeatures.Token.TrustProviderJid
getset

JID of Trust Provider, asserting claims in the token.

Definition at line 203 of file Token.cs.

◆ Updated

DateTime NeuroFeatures.Token.Updated
getset

When token was updated.

Definition at line 350 of file Token.cs.

◆ Valuator

string [] NeuroFeatures.Token.Valuator
getset

Optional Legal IDs of parties used to estimate the value of the token.

Definition at line 287 of file Token.cs.

◆ Value

decimal NeuroFeatures.Token.Value
getset

Latest value of token

Definition at line 332 of file Token.cs.

◆ Visibility

ContractVisibility NeuroFeatures.Token.Visibility
getset

Token visibility

Definition at line 142 of file Token.cs.

◆ Witness

string [] NeuroFeatures.Token.Witness
getset

Optional Legal IDs of witnesses during the construction of the token.

Definition at line 323 of file Token.cs.


The documentation for this class was generated from the following file: