Class Account
Definition
- Namespace:
- Tizen.Account.AccountManager
- Assembly:
- Tizen.Account.AccountManager.dll
Represents the account information.
public class Account : IDisposable
- Inheritance
-
objectAccount
- Implements
-
System.IDisposable
Constructors
View SourceAccount(SafeAccountHandle)
Account constructor.
Declaration
public Account(SafeAccountHandle handle)
Parameters
Type | Name | Description |
---|---|---|
SafeAccountHandle | handle | The account handle. |
Properties
View SourceAccessToken
Access token of the account.
Declaration
public string AccessToken { get; set; }
Property Value
Type | Description |
---|---|
string | Access token of the account. |
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.
AuthType
Authentication type of the account.
Declaration
public AccountAuthType AuthType { get; set; }
Property Value
Type | Description |
---|---|
AccountAuthType | Authentication type of the account. |
DisplayName
Display name of the account.
Declaration
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | Display name of the account. |
DomainName
Domain name of the account.
Declaration
public string DomainName { get; set; }
Property Value
Type | Description |
---|---|
string | Domain name of the account. |
EmailId
Email ID of the account.
Declaration
public string EmailId { get; set; }
Property Value
Type | Description |
---|---|
string | Email ID of the account. |
IconPath
Icon path of the account.
Declaration
public string IconPath { get; set; }
Property Value
Type | Description |
---|---|
string | Icon path of the account. |
PackageName
Package name of the account.
Declaration
public string PackageName { get; set; }
Property Value
Type | Description |
---|---|
string | Package name of the account. |
SafeAccountHandle
Handle of the account.
Declaration
public SafeAccountHandle SafeAccountHandle { get; }
Property Value
Type | Description |
---|---|
SafeAccountHandle | Account handle. |
SecrecyState
Secrecy state of the account.
Declaration
public AccountSecrecyState SecrecyState { get; set; }
Property Value
Type | Description |
---|---|
AccountSecrecyState | Secrecy state of the account. |
Source
Source of the account.
Declaration
public string Source { get; set; }
Property Value
Type | Description |
---|---|
string | Account source. |
SyncState
Sync state of the account.
Declaration
public AccountSyncState SyncState { get; set; }
Property Value
Type | Description |
---|---|
AccountSyncState | Sync state of the account. |
UserName
UserName of the account.
Declaration
public string UserName { get; set; }
Property Value
Type | Description |
---|---|
string | User name of the account. |
Methods
View SourceCreateAccount()
Creates a new account instance.
Declaration
public static Account CreateAccount()
Returns
Type | Description |
---|---|
Account | Account Instance. |
Dispose()
Overloaded Dispose API for destroying the account handle.
Declaration
public void Dispose()
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. |
~Account()
Account destructor.
Declaration
protected ~Account()
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |