Class ComponentManager

Definition

Namespace:

Tizen.Applications.ComponentBased

Assembly:

Tizen.Applications.ComponentBased.ComponentManager.dll

This class has the methods and events of the ComponentManager.

public static class ComponentManager

Inheritance

object

ComponentManager

Methods

GetInstalledComponentsAsync()

Gets the information of the installed components asynchronously.

Declaration

public static Task<IEnumerable<ComponentInfo>> GetInstalledComponentsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><System.Collections.Generic.IEnumerable<T><ComponentInfo>>	The installed component info list.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown when failed because of the "component not exist" error or the system error.
System.OutOfMemoryException	Thrown when failed because of out of memory.
System.UnauthorizedAccessException	Thrown when failed because of permission denied.

GetRunningComponentsAsync()

Gets the information of the running components asynchronously.

Declaration

public static Task<IEnumerable<ComponentRunningContext>> GetRunningComponentsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<TResult><System.Collections.Generic.IEnumerable<T><ComponentRunningContext>>	The component running context list.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown when failed because of the "component not exist" error or the system error.
System.OutOfMemoryException	Thrown when failed because of out of memory.
System.UnauthorizedAccessException	Thrown when failed because of permission denied.

IsRunning(string)

Checks whether the component is running or not.

Declaration

public static bool IsRunning(string componentId)

Parameters

Type	Name	Description
string	componentId	Component ID.

Returns

Type	Description
bool	Returns true if the component is running, otherwise false.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown when failed because of the "component not exist" error or the system error.
System.OutOfMemoryException	Thrown when failed because of out of memory.
System.UnauthorizedAccessException	Thrown when failed because of permission denied.

TerminateBackgroundComponent(ComponentRunningContext)

Terminates the component if it is running in the background.

Declaration

public static void TerminateBackgroundComponent(ComponentRunningContext context)

Parameters

Type	Name	Description
ComponentRunningContext	context	Component ID

Remarks

This function returns after it just sends a request for terminating a background component. Platform will decide if the target component could be terminated or not according to the state of the target component.

Exceptions

Type	Condition
System.ArgumentException	Thrown when failed because of an invalid argument.
System.InvalidOperationException	Thrown when failed because of the "component not exist" error or the system error.
System.OutOfMemoryException	Thrown when failed because of out of memory.
System.UnauthorizedAccessException	Thrown when failed because of permission denied.