Class AccountService

Definition

Namespace:: Tizen.Account.AccountManager

Assembly:: Tizen.Account.AccountManager.dll

The AccountManager APIs are separated into two major sections:

Registering an account provider while an application is installed. This information will be used for the Add account screen.
Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu.

The APIs of both of the sections consist of the following functionality:

Create an account or account provider.
Update an account or account provider (Only available for the creator).
Delete an account or account provider (Only available for the creator).
Read an account or account provider with some filter.


                C#
                
                    Copy
                    
                
            
public static class AccountService

Inheritance: object

AccountService

Fields

View Source

CalendarCapability

This is the calendar capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string CalendarCapability

Field Value

Type	Description
string

View Source

ContactCapability

This is the contact capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string ContactCapability

Field Value

Type	Description
string

View Source

DocumentCapability

This is the document capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string DocumentCapability

Field Value

Type	Description
string

View Source

EmailCapability

This is the email capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string EmailCapability

Field Value

Type	Description
string

View Source

GameCapability

This is the game capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string GameCapability

Field Value

Type	Description
string

View Source

MessageCapability

This is the message capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string MessageCapability

Field Value

Type	Description
string

View Source

MusicCapability

This is the music capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string MusicCapability

Field Value

Type	Description
string

View Source

PhotoCapability

This is the photo capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string PhotoCapability

Field Value

Type	Description
string

View Source

VideoCapability

This is the video capability string.

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly string VideoCapability

Field Value

Type	Description
string

Methods

View Source

AddAccount(Account)

Inserts into the Database with the new account Information.

Declaration


                C#
                
                    Copy
                    
                
            
public static int AddAccount(Account account)

Parameters

Type	Name	Description
Account	account	New Account instance to be added.

Returns

Type	Description
int	The account ID of the account instance.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.OutOfMemoryException	In case of OutOfMemory error.
System.NotSupportedException	The required feature is not supported.

View Source

DeleteAccount(string, string)

Deletes the account from the account database by user name.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DeleteAccount(string userName, string packageName)

Parameters

Type	Name	Description
string	userName	The user name of the account to delete.
string	packageName	The package name of the account to delete.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

DeleteAccount(string)

Deletes the account from the account database by package name.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DeleteAccount(string packageName)

Parameters

Type	Name	Description
string	packageName	The package name of the account to delete.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

DeleteAccount(Account)

Deletes the account information from the database.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DeleteAccount(Account account)

Parameters

Type	Name	Description
Account	account	Account instance to be deleted from the database.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountById(int)

Retrieves the account with the account ID.

Declaration


                C#
                
                    Copy
                    
                
            
public static Account GetAccountById(int accountId)

Parameters

Type	Name	Description
int	accountId	The account ID to be searched.

Returns

Type	Description
Account	Account instance with reference to the given ID.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given account ID.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountProviderByAppId(string)

Retrieves the account provider information with the application ID.

Declaration


                C#
                
                    Copy
                    
                
            
public static AccountProvider GetAccountProviderByAppId(string appId)

Parameters

Type	Name	Description
string	appId	The application ID.

Returns

Type	Description
AccountProvider	The AccountProvider instance associated with the given application ID.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given appId.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountProviders()

Retrieves all the AccountProviders details from the account database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<AccountProvider> GetAccountProviders()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><AccountProvider>	List of AccountProviders.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountProvidersByFeature(string)

Retrieves all the account providers information with feature.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<AccountProvider> GetAccountProvidersByFeature(string feature)

Parameters

Type	Name	Description
string	feature	The capability value to search for account providers.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><AccountProvider>	Retrieves the AccountProviders information with the capability name.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given feature.
System.ArgumentException	In case of invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountsAsync()

Retrieves all the accounts details from the account database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<Account> GetAccountsAsync()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><Account>	List of accounts.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountsByCapabilityType(string)

Retrieves all accounts with the given capability type.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<Account> GetAccountsByCapabilityType(string type)

Parameters

Type	Name	Description
string	type	Capability type.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><Account>	Accounts list matched with the capability type.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for the given capability type.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountsByPackageName(string)

Retrieves all the accounts with the given package name.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<Account> GetAccountsByPackageName(string packageName)

Parameters

Type	Name	Description
string	packageName	The package name to search.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><Account>	Accounts list matched with the package name.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given package name.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountsByUserName(string)

Retrieves all the accounts with the given user name.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<Account> GetAccountsByUserName(string userName)

Parameters

Type	Name	Description
string	userName	The user name to search.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><Account>	Accounts list matched with the user name.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given username.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetAccountsCount()

Gets the count of accounts in the account database.

Declaration


                C#
                
                    Copy
                    
                
            
public static int GetAccountsCount()

Returns

Type	Description
int	The number of accounts in the database.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

GetCapabilitiesById(int)

Retrieves all the capabilities with the given account.

Declaration


                C#
                
                    Copy
                    
                
            
public static Dictionary<string, CapabilityState> GetCapabilitiesById(int accountId)

Parameters

Type	Name	Description
int	accountId	Account instance.

Returns

Type	Description
System.Collections.Generic.Dictionary<TKey, TValue><string, CapabilityState>	Capabilities list as dictionary of the capability type and state.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error or record not found for given account ID.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

View Source

UpdateAccount(Account)

Updates the account details to the account database.

Declaration


                C#
                
                    Copy
                    
                
            
public static void UpdateAccount(Account account)

Parameters

Type	Name	Description
Account	account	Account instance to be updated.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.OutOfMemoryException	In case of OutOfMemory error.
System.NotSupportedException	The required feature is not supported.

View Source

UpdateSyncStatusById(Account, AccountSyncState)

Updates the sync status of the given account.

Declaration


                C#
                
                    Copy
                    
                
            
public static void UpdateSyncStatusById(Account account, AccountSyncState status)

Parameters

Type	Name	Description
Account	account	Account for which the sync status needs to be updated.
AccountSyncState	status	Sync State

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.

Events

View Source

AccountUpdated

ContentUpdated event is triggered when the media item info from DB changes.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<AccountSubscriberEventArgs> AccountUpdated

Event Type

Type	Description
System.EventHandler<TEventArgs><AccountSubscriberEventArgs>

Remarks

ContentUpdate event is triggered if the MediaInformation updated/deleted or new information is inserted.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any DB error.
System.ArgumentException	In case of an invalid parameter.
System.UnauthorizedAccessException	In case of privilege not defined.
System.NotSupportedException	The required feature is not supported.