Class Account

    Definition

    Namespace:
    Tizen.Account.AccountManager
    Assembly:
    Tizen.Account.AccountManager.dll

    Represents the account information.

    public class Account : IDisposable
    Inheritance
    object
    Account
    Implements
    System.IDisposable

    Constructors

    View Source

    Account(SafeAccountHandle)

    Account constructor.

    Declaration
    public Account(SafeAccountHandle handle)
    Parameters
    Type Name Description
    SafeAccountHandle handle

    The account handle.

    Properties

    View Source

    AccessToken

    Access token of the account.

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

    Access token of the account.

    View Source

    AccountId

    Id of the Account.

    Declaration
    public int AccountId { get; }
    Property Value
    Type Description
    int
    Remarks

    Account ID shall be created only when the account is added to the database.

    View Source

    AuthType

    Authentication type of the account.

    Declaration
    public AccountAuthType AuthType { get; set; }
    Property Value
    Type Description
    AccountAuthType

    Authentication type of the account.

    View Source

    DisplayName

    Display name of the account.

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

    Display name of the account.

    View Source

    DomainName

    Domain name of the account.

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

    Domain name of the account.

    View Source

    EmailId

    Email ID of the account.

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

    Email ID of the account.

    View Source

    IconPath

    Icon path of the account.

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

    Icon path of the account.

    View Source

    PackageName

    Package name of the account.

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

    Package name of the account.

    View Source

    SafeAccountHandle

    Handle of the account.

    Declaration
    public SafeAccountHandle SafeAccountHandle { get; }
    Property Value
    Type Description
    SafeAccountHandle

    Account handle.

    View Source

    SecrecyState

    Secrecy state of the account.

    Declaration
    public AccountSecrecyState SecrecyState { get; set; }
    Property Value
    Type Description
    AccountSecrecyState

    Secrecy state of the account.

    View Source

    Source

    Source of the account.

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

    Account source.

    View Source

    SyncState

    Sync state of the account.

    Declaration
    public AccountSyncState SyncState { get; set; }
    Property Value
    Type Description
    AccountSyncState

    Sync state of the account.

    View Source

    UserName

    UserName of the account.

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

    User name of the account.

    Methods

    View Source

    CreateAccount()

    Creates a new account instance.

    Declaration
    public static Account CreateAccount()
    Returns
    Type Description
    Account

    Account Instance.

    View Source

    Dispose()

    Overloaded Dispose API for destroying the account handle.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Dispose API for destroying the account handle.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    The boolean value for destoying account handle.

    View Source

    ~Account()

    Account destructor.

    Declaration
    protected ~Account()
    View Source

    GetAllCapabilities()

    Gets all the capabilities of the account.

    Declaration
    public Dictionary<string, CapabilityState> GetAllCapabilities()
    Returns
    Type Description
    System.Collections.Generic.Dictionary<TKey, TValue><string, CapabilityState>

    List of capabilities as dictionary.

    View Source

    GetAllCustomValues()

    Gets all the custom values.

    Declaration
    public Dictionary<string, string> GetAllCustomValues()
    Returns
    Type Description
    System.Collections.Generic.Dictionary<TKey, TValue><string, string>

    List of custom key, value pairs as dictionary.

    View Source

    GetCapability(string)

    Gets all the capabilities of the account.

    Declaration
    public CapabilityState GetCapability(string capabilityType)
    Parameters
    Type Name Description
    string capabilityType

    The capability type to get the capability value.

    Returns
    Type Description
    CapabilityState

    The capability value (on/off) of the specified CapabilityState.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    View Source

    GetCustomValue(string)

    Gets the user specific custom text of an account key.

    Declaration
    public string GetCustomValue(string key)
    Parameters
    Type Name Description
    string key

    The key to retrieve custom text.

    Returns
    Type Description
    string

    The text of the given key.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    System.InvalidOperationException

    If there is no given capability type in the account.

    View Source

    GetUserInt(int)

    Gets the user integer value.

    Declaration
    public int GetUserInt(int index)
    Parameters
    Type Name Description
    int index

    The index of the user integer (must be in range from 0 to 4).

    Returns
    Type Description
    int

    The user integer of the given key.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    View Source

    GetUserText(int)

    Gets the user text.

    Declaration
    public string GetUserText(int index)
    Parameters
    Type Name Description
    int index

    The index of the user text (must be in range from 0 to 4).

    Returns
    Type Description
    string

    The user text of the given key.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    System.OutOfMemoryException

    In case of out of memory.

    View Source

    SetCapability(string, CapabilityState)

    Sets the account capability.

    Declaration
    public void SetCapability(string capabilityType, CapabilityState state)
    Parameters
    Type Name Description
    string capabilityType

    The account capability type.

    CapabilityState state

    The account capability state.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    View Source

    SetCustomValue(string, string)

    Sets the custom value to the account.

    Declaration
    public void SetCustomValue(string key, string value)
    Parameters
    Type Name Description
    string key

    Key to be added to the account.

    string value

    Value to be updated for respective key for the account.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    View Source

    SetUserInt(int, int)

    Sets the user integer value.

    Declaration
    public void SetUserInt(int index, int value)
    Parameters
    Type Name Description
    int index

    The index of the user integer (must be in range from 0 to 4).

    int value

    The integer to set as the user integer.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    View Source

    SetUserText(int, string)

    Sets the user text.

    Declaration
    public void SetUserText(int index, string text)
    Parameters
    Type Name Description
    int index

    The index of the user text (must be in range from 0 to 4).

    string text

    The text string to set as the user text.

    Exceptions
    Type Condition
    System.ArgumentException

    In case of an invalid parameter.

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX