Show / Hide Table of Contents

    Class Account

    Account Description

    Inheritance
    System.Object
    Account
    Implements
    System.IEquatable<Account>
    System.ComponentModel.DataAnnotations.IValidatableObject
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Algorand.Algod.Model
    Assembly: Algorand.dll
    Syntax
    [DataContract]
    public class Account : IEquatable<Account>, IValidatableObject

    Constructors

    | Improve this Doc View Source

    Account(String, Nullable<UInt64>, Nullable<UInt64>, Dictionary<Nullable<UInt64>, AssetHolding>, Participation, Nullable<UInt64>, Nullable<UInt64>, Nullable<UInt64>, String, Dictionary<Nullable<UInt64>, AssetParams>)

    Initializes a new instance of the Account class.

    Declaration
    public Account(string address = null, ulong? amount = default(ulong? ), ulong? amountwithoutpendingrewards = default(ulong? ), Dictionary<ulong?, AssetHolding> assets = null, Participation participation = null, ulong? pendingrewards = default(ulong? ), ulong? rewards = default(ulong? ), ulong? round = default(ulong? ), string status = null, Dictionary<ulong?, AssetParams> thisassettotal = null)
    Parameters
    Type Name Description
    System.String address

    Address indicates the account public key (required).

    System.Nullable<System.UInt64> amount

    Amount indicates the total number of MicroAlgos in the account (required).

    System.Nullable<System.UInt64> amountwithoutpendingrewards

    AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account, without the pending rewards. (required).

    System.Collections.Generic.Dictionary<System.Nullable<System.UInt64>, AssetHolding> assets

    Assets specifies the holdings of assets by this account, indexed by the asset ID..

    Participation participation

    participation.

    System.Nullable<System.UInt64> pendingrewards

    PendingRewards specifies the amount of MicroAlgos of pending rewards in this account. (required).

    System.Nullable<System.UInt64> rewards

    Rewards indicates the total rewards of MicroAlgos the account has received, including pending rewards. (required).

    System.Nullable<System.UInt64> round

    Round indicates the round for which this information is relevant (required).

    System.String status

    Status indicates the delegation status of the account's MicroAlgos Offline - indicates that the associated account is delegated. Online - indicates that the associated account used as part of the delegation pool. NotParticipating - indicates that the associated account is neither a delegator nor a delegate. (required).

    System.Collections.Generic.Dictionary<System.Nullable<System.UInt64>, AssetParams> thisassettotal

    AssetParams specifies the parameters of assets created by this account..

    Properties

    | Improve this Doc View Source

    Address

    Address indicates the account public key

    Declaration
    [DataMember(Name = "address", EmitDefaultValue = false)]
    public string Address { get; set; }
    Property Value
    Type Description
    System.String

    Address indicates the account public key

    | Improve this Doc View Source

    Amount

    Amount indicates the total number of MicroAlgos in the account

    Declaration
    [DataMember(Name = "amount", EmitDefaultValue = false)]
    public ulong? Amount { get; set; }
    Property Value
    Type Description
    System.Nullable<System.UInt64>

    Amount indicates the total number of MicroAlgos in the account

    | Improve this Doc View Source

    Amountwithoutpendingrewards

    AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account, without the pending rewards.

    Declaration
    [DataMember(Name = "amountwithoutpendingrewards", EmitDefaultValue = false)]
    public ulong? Amountwithoutpendingrewards { get; set; }
    Property Value
    Type Description
    System.Nullable<System.UInt64>

    AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account, without the pending rewards.

    | Improve this Doc View Source

    Assets

    Assets specifies the holdings of assets by this account, indexed by the asset ID.

    Declaration
    [DataMember(Name = "assets", EmitDefaultValue = false)]
    public Dictionary<ulong?, AssetHolding> Assets { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.Nullable<System.UInt64>, AssetHolding>

    Assets specifies the holdings of assets by this account, indexed by the asset ID.

    | Improve this Doc View Source

    Participation

    Gets or Sets Participation

    Declaration
    [DataMember(Name = "participation", EmitDefaultValue = false)]
    public Participation Participation { get; set; }
    Property Value
    Type Description
    Participation
    | Improve this Doc View Source

    Pendingrewards

    PendingRewards specifies the amount of MicroAlgos of pending rewards in this account.

    Declaration
    [DataMember(Name = "pendingrewards", EmitDefaultValue = false)]
    public ulong? Pendingrewards { get; set; }
    Property Value
    Type Description
    System.Nullable<System.UInt64>

    PendingRewards specifies the amount of MicroAlgos of pending rewards in this account.

    | Improve this Doc View Source

    Rewards

    Rewards indicates the total rewards of MicroAlgos the account has received, including pending rewards.

    Declaration
    [DataMember(Name = "rewards", EmitDefaultValue = false)]
    public ulong? Rewards { get; set; }
    Property Value
    Type Description
    System.Nullable<System.UInt64>

    Rewards indicates the total rewards of MicroAlgos the account has received, including pending rewards.

    | Improve this Doc View Source

    Round

    Round indicates the round for which this information is relevant

    Declaration
    [DataMember(Name = "round", EmitDefaultValue = false)]
    public ulong? Round { get; set; }
    Property Value
    Type Description
    System.Nullable<System.UInt64>

    Round indicates the round for which this information is relevant

    | Improve this Doc View Source

    Status

    Status indicates the delegation status of the account's MicroAlgos Offline - indicates that the associated account is delegated. Online - indicates that the associated account used as part of the delegation pool. NotParticipating - indicates that the associated account is neither a delegator nor a delegate.

    Declaration
    [DataMember(Name = "status", EmitDefaultValue = false)]
    public string Status { get; set; }
    Property Value
    Type Description
    System.String

    Status indicates the delegation status of the account's MicroAlgos Offline - indicates that the associated account is delegated. Online - indicates that the associated account used as part of the delegation pool. NotParticipating - indicates that the associated account is neither a delegator nor a delegate.

    | Improve this Doc View Source

    Thisassettotal

    AssetParams specifies the parameters of assets created by this account.

    Declaration
    [DataMember(Name = "thisassettotal", EmitDefaultValue = false)]
    public Dictionary<ulong?, AssetParams> Thisassettotal { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.Nullable<System.UInt64>, AssetParams>

    AssetParams specifies the parameters of assets created by this account.

    Methods

    | Improve this Doc View Source

    Equals(Account)

    Returns true if Account instances are equal

    Declaration
    public bool Equals(Account input)
    Parameters
    Type Name Description
    Account input

    Instance of Account to be compared

    Returns
    Type Description
    System.Boolean

    Boolean

    | Improve this Doc View Source

    Equals(Object)

    Returns true if objects are equal

    Declaration
    public override bool Equals(object input)
    Parameters
    Type Name Description
    System.Object input

    Object to be compared

    Returns
    Type Description
    System.Boolean

    Boolean

    Overrides
    System.Object.Equals(System.Object)
    | Improve this Doc View Source

    GetHashCode()

    Gets the hash code

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    Hash code

    Overrides
    System.Object.GetHashCode()
    | Improve this Doc View Source

    GetHolding(Nullable<UInt64>)

    Declaration
    public AssetHolding GetHolding(ulong? assetIndex)
    Parameters
    Type Name Description
    System.Nullable<System.UInt64> assetIndex
    Returns
    Type Description
    AssetHolding
    | Improve this Doc View Source

    ToJson()

    Returns the JSON string presentation of the object

    Declaration
    public virtual string ToJson()
    Returns
    Type Description
    System.String

    JSON string presentation of the object

    | Improve this Doc View Source

    ToString()

    Returns the string presentation of the object

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    String presentation of the object

    Overrides
    System.Object.ToString()

    Explicit Interface Implementations

    | Improve this Doc View Source

    IValidatableObject.Validate(ValidationContext)

    To validate all properties of the instance

    Declaration
    IEnumerable<ValidationResult> IValidatableObject.Validate(ValidationContext validationContext)
    Parameters
    Type Name Description
    System.ComponentModel.DataAnnotations.ValidationContext validationContext

    Validation context

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult>

    Validation Result

    Implements

    System.IEquatable<T>
    System.ComponentModel.DataAnnotations.IValidatableObject
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX