using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
+using System.Threading.Tasks;
namespace Tizen.Applications
{
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public class AppControl
{
private const string LogTag = "Tizen.Applications";
- private static Dictionary<int, Interop.AppControl.ReplyCallback> s_replyNativeCallbackMaps = new Dictionary<int, Interop.AppControl.ReplyCallback>();
- private static int s_replyNativeCallbackId = 0;
+ private static Dictionary<int, Interop.AppControl.ResultCallback> s_resultNativeCallbackMaps = new Dictionary<int, Interop.AppControl.ResultCallback>();
+ private static Dictionary<int, AppControlReplyCallback> s_replyCallbackMaps = new Dictionary<int, AppControlReplyCallback>();
+ private static int s_reaustId = 0;
private readonly SafeAppControlHandle _handle;
private string _category = null;
private string _applicationId = null;
private ExtraDataCollection _extraData = null;
+ private string _componentId = null;
/// <summary>
/// Initializes the instance of the AppControl class.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when failed to create AppControl handle.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to create the AppControl handle.</exception>
+ /// <since_tizen> 3 </since_tizen>
public AppControl()
{
Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle);
}
/// <summary>
- /// Initializes the instance of the AppControl class with parameter.
+ /// Initializes the instance of the AppControl class with a parameter.
/// </summary>
- /// <param name="enableAppStartedResultEvent">The flag value to receive an additional launch result event on launch request.</param>
- /// <exception cref="InvalidOperationException">Thrown when failed to create AppControl handle.</exception>
+ /// <param name="enableAppStartedResultEvent">The flag value to receive an additional launch result event on the launch request.</param>
+ /// <exception cref="InvalidOperationException">Thrown when failed to create the AppControl handle.</exception>
+ /// <since_tizen> 3 </since_tizen>
public AppControl(bool enableAppStartedResultEvent)
{
Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle);
/// Initializes the instance of the AppControl class with the SafeAppControlHandle.
/// </summary>
/// <param name="handle"></param>
+ /// <since_tizen> 3 </since_tizen>
public AppControl(SafeAppControlHandle handle)
{
if (handle == null)
}
}
- #region Public Properties
+ private static Interop.AppControl.ReplyCallback s_replyNativeCallback = (launchHandle, replyHandle, result, userData) =>
+ {
+ int requestId = (int)userData;
+ lock (s_replyCallbackMaps)
+ {
+ if (s_replyCallbackMaps.ContainsKey(requestId))
+ {
+ s_replyCallbackMaps[requestId](new AppControl(launchHandle), new AppControl(replyHandle), (AppControlReplyResult)result);
+ if (result != Interop.AppControl.AppStartedStatus)
+ {
+ lock (s_replyCallbackMaps)
+ {
+ s_replyCallbackMaps.Remove(requestId);
+ }
+ }
+ }
+ }
+ };
+
+#region Public Properties
/// <summary>
/// Gets the SafeAppControlHandle instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public SafeAppControlHandle SafeAppControlHandle
{
get
/// Log.Debug(LogTag, "Operation: " + appControl.Operation);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public string Operation
{
get
/// Log.Debug(LogTag, "Mime: " + appControl.Mime);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public string Mime
{
get
/// </summary>
/// <value>
/// Since Tizen 2.4, if the parameter 'uri' is started with 'file://' and
- /// it is a regular file in this application's data path which can be obtained
+ /// it is a regular file in this application's data path, which can be obtained
/// by property DataPath in ApplicationInfo class,
/// it will be shared to the callee application.
/// Framework will grant a temporary permission to the callee application for this file and
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public string Uri
{
get
/// <value>
/// (if the category is null for setter, it clears the previous value.)
/// </value>
+ /// <since_tizen> 3 </since_tizen>
public string Category
{
get
}
/// <summary>
- /// Gets and sets the application id to explicitly launch.
+ /// Gets and sets the application ID to explicitly launch.
/// </summary>
/// <value>
- /// (if the application id is null for setter, it clears the previous value.)
+ /// (if the application ID is null for setter, it clears the previous value.)
/// </value>
/// <example>
/// <code>
/// Log.Debug(LogTag, "ApplicationId: " + appControl.ApplicationId);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public string ApplicationId
{
get
/// Gets and sets the launch mode of the application.
/// </summary>
/// <value>
- /// Although LaunchMode were set as AppControlLaunchMode.Group,
- /// callee application would be launched as single mode
+ /// Although, LaunchMode were set as AppControlLaunchMode.Group, the
+ /// callee application would be launched as a single mode
/// if the manifest file of callee application defined the launch mode as "single".
- /// This property can just set the preference of caller application to launch an application.
- /// Sub-applications which were launched as group mode always have own process.
- /// Since Tizen 3.0, if launch mode not set in the caller app control,
- /// this property returns AppControlLaunchMode.Single launch mode.
+ /// This property can just set the preference of the caller application to launch an application.
+ /// Sub-applications, which were launched as a group mode always have own process.
+ /// Since Tizen 3.0, if launch mode is not set in the caller application control,
+ /// this property returns the AppControlLaunchMode.Single launch mode.
/// </value>
/// <example>
/// <code>
/// appControl.LaunchMode = AppControlLaunchMode.Group;
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public AppControlLaunchMode LaunchMode
{
get
/// ...
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public ExtraDataCollection ExtraData
{
get
}
}
- #endregion // Public Properties
+ /// <summary>
+ /// Gets and sets the component ID to explicitly launch a component.
+ /// </summary>
+ /// <value>
+ /// (if the component ID is null for setter, it clears the previous value.)
+ /// From Tizen 5.5, a new application model is supported that is component-based application.
+ /// This property is for launching component-based application. If it's not set, the main component of component-based application will be launched.
+ /// If the target app is not component-based application, setting property is meaningless.
+ /// </value>
+ /// <example>
+ /// <code>
+ /// AppControl appControl = new AppControl();
+ /// appControl.ApplicationId = "org.tizen.component-based-app"; // component-based application
+ /// appControl.ComponentId = "org.tizen.frame-component";
+ /// AppControl.SendLaunchRequest(appControl);
+ /// </code>
+ /// </example>
+ /// <since_tizen> 6 </since_tizen>
+ public string ComponentId
+ {
+ get
+ {
+ if (String.IsNullOrEmpty(_componentId))
+ {
+ Interop.AppControl.ErrorCode err = Interop.AppControl.GetComponentId(_handle, out _componentId);
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ Log.Warn(LogTag, "Failed to get the component id from the AppControl. Err = " + err);
+ }
+ }
+ return _componentId;
+ }
+ set
+ {
+ Interop.AppControl.ErrorCode err = Interop.AppControl.SetComponentId(_handle, value);
+ if (err == Interop.AppControl.ErrorCode.None)
+ {
+ _componentId = value;
+ }
+ else
+ {
+ Log.Warn(LogTag, "Failed to set the component id to the AppControl. Err = " + err);
+ }
+ }
+ }
+
+#endregion // Public Properties
/// <summary>
/// Retrieves all applications that can be launched to handle the given app_control request.
/// </summary>
- /// <param name="control">The AppControl</param>
- /// <returns>ApplicationIds</returns>
- /// <exception cref="InvalidOperationException">Thrown when failed because of invalid parameter</exception>
+ /// <param name="control">The AppControl.</param>
+ /// <returns>ApplicationIds.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid parameter.</exception>
/// <example>
/// <code>
- /// IEnumerable<string> applicationIds = AppControl.GetMatchedApplicationIds(control);
+ /// IEnumerable<string> applicationIds = AppControl.GetMatchedApplicationIds(control);
/// if (applicationIds != null)
/// {
/// foreach (string id in applicationIds)
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static IEnumerable<string> GetMatchedApplicationIds(AppControl control)
{
if (control == null)
/// <remarks>
/// The operation is mandatory information for the launch request.
/// If the operation is not specified, AppControlOperations.Default is used by default.
- /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n
+ /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application.<br/>
/// Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform.
/// Also, implicit launch requests are NOT delivered to service applications since 2.4.
- /// To launch a service application, an explicit launch request with application ID given by property ApplicationId MUST be sent.
+ /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent.
/// </remarks>
- /// <param name="launchRequest">The AppControl</param>
- /// <exception cref="ArgumentNullException">Thrown when failed because of a null arguament</exception>
- /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception>
- /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception>
+ /// <param name="launchRequest">The AppControl.</param>
+ /// <exception cref="ArgumentNullException">Thrown when failed because of a null argument.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception>
+ /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
/// <example>
/// <code>
/// AppControl.SendLaunchRequest(appControl);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendLaunchRequest(AppControl launchRequest)
{
SendLaunchRequest(launchRequest, null);
/// <remarks>
/// The operation is mandatory information for the launch request.
/// If the operation is not specified, AppControlOperations.Default is used by default.
- /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n
+ /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application.<br/>
/// Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform.
/// Also, implicit launch requests are NOT delivered to service applications since 2.4.
- /// To launch a service application, an explicit launch request with application ID given by property ApplicationId MUST be sent.
+ /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent.
/// </remarks>
- /// <param name="launchRequest">The AppControl</param>
- /// <param name="replyAfterLaunching">The callback function to be called when the reply is delivered</param>
- /// <exception cref="ArgumentException">Thrown when failed because of arguament is invalid</exception>
- /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception>
- /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception>
+ /// <param name="launchRequest">The AppControl.</param>
+ /// <param name="replyAfterLaunching">The callback function to be called when the reply is delivered.</param>
+ /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception>
+ /// <exception cref="Exceptions.AppNotFoundException">Thrown when the application to run is not found.</exception>
+ /// <exception cref="Exceptions.LaunchFailedException">Thrown when the request failed to launch the application.</exception>
+ /// <exception cref="Exceptions.LaunchRejectedException">Thrown when the launch request is rejected.</exception>
+ /// <exception cref="Exceptions.OutOfMemoryException">Thrown when the memory is insufficient.</exception>
+ /// <exception cref="Exceptions.PermissionDeniedException">Thrown when the permission is denied.</exception>
+ /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception>
/// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
/// <example>
/// <code>
/// });
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendLaunchRequest(AppControl launchRequest, AppControlReplyCallback replyAfterLaunching)
{
if (launchRequest == null)
if (replyAfterLaunching != null)
{
int id = 0;
- lock (s_replyNativeCallbackMaps)
+ lock (s_replyCallbackMaps)
{
- id = s_replyNativeCallbackId++;
- s_replyNativeCallbackMaps[id] = (launchRequestHandle, replyRequestHandle, result, userData) =>
- {
- if (replyAfterLaunching != null)
- {
- Log.Debug(LogTag, "Reply Callback is launched");
- replyAfterLaunching(new AppControl(launchRequestHandle), new AppControl(replyRequestHandle), (AppControlReplyResult)result);
- if (result != Interop.AppControl.AppStartedStatus)
- {
- lock (s_replyNativeCallbackMaps)
- {
- s_replyNativeCallbackMaps.Remove(id);
- }
- }
- }
- };
+ id = s_reaustId++;
+ s_replyCallbackMaps[id] = replyAfterLaunching;
}
- err = Interop.AppControl.SendLaunchRequest(launchRequest._handle, s_replyNativeCallbackMaps[id], IntPtr.Zero);
+ err = Interop.AppControl.SendLaunchRequest(launchRequest._handle, s_replyNativeCallback, (IntPtr)id);
}
else
{
throw new ArgumentException("Invalid Arguments");
case Interop.AppControl.ErrorCode.TimedOut:
throw new TimeoutException("Timed out");
+ case Interop.AppControl.ErrorCode.OutOfMemory:
+ throw new Exceptions.OutOfMemoryException("Out-of-memory");
+ case Interop.AppControl.ErrorCode.AppNotFound:
+ throw new Exceptions.AppNotFoundException("App(" + launchRequest.ApplicationId + ") not found. Operation(" + launchRequest.Operation + ")");
+ case Interop.AppControl.ErrorCode.LaunchRejected:
+ throw new Exceptions.LaunchRejectedException("Launch rejected");
+ case Interop.AppControl.ErrorCode.LaunchFailed:
+ throw new Exceptions.LaunchFailedException("Launch failed");
+ case Interop.AppControl.ErrorCode.PermissionDenied:
+ throw new Exceptions.PermissionDeniedException("Permission denied");
+
default:
- throw new InvalidOperationException("Error = " + err);
+ throw new Exceptions.LaunchRejectedException("Launch rejected");
}
}
}
/// </summary>
/// <remarks>
/// You are not allowed to terminate other general applications using this API.
- /// This API can be used to terminate sub-applications which were launched as group mode by caller application.
- /// Once callee application is being terminated by this API,
- /// other applications which were launched by callee application as group mode will be terminated as well
+ /// This API can be used to terminate sub-applications, which were launched as a group mode by the caller application.
+ /// Once the callee application is being terminated by this API,
+ /// other applications, which were launched by the callee application as a group mode will be terminated as well.
/// </remarks>
- /// <param name="terminateRequest">The AppControl</param>
- /// <exception cref="ArgumentException">Thrown when failed because of arguament is invalid</exception>
- /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception>
- /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception>
+ /// <param name="terminateRequest">The AppControl.</param>
+ /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception>
+ /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception>
/// <example>
/// <code>
/// AppControl terminateRequest = new AppControl();
/// AppControl.SendTerminateRequest(terminateRequest);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendTerminateRequest(AppControl terminateRequest)
{
if (terminateRequest == null)
}
/// <summary>
- /// Class for Extra Data
+ /// Sends the launch request asynchronously.
+ /// </summary>
+ /// <remarks>
+ /// The operation is mandatory information for the launch request.
+ /// If the operation is not specified, AppControlOperations.Default is used by default.
+ /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application.<br/>
+ /// Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform.
+ /// Also, implicit launch requests are NOT delivered to service applications since 2.4.
+ /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent.
+ /// </remarks>
+ /// <param name="launchRequest">The AppControl.</param>
+ /// <param name="replyAfterLaunching">The callback function to be called when the reply is delivered.</param>
+ /// <returns>A task with the result of the launch request.</returns>
+ /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception>
+ /// <exception cref="Exceptions.AppNotFoundException">Thrown when the application to run is not found.</exception>
+ /// <exception cref="Exceptions.LaunchRejectedException">Thrown when the launch request is rejected.</exception>
+ /// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
+ /// <since_tizen> 6 </since_tizen>
+ public static Task<AppControlResult> SendLaunchRequestAsync(AppControl launchRequest, AppControlReplyCallback replyAfterLaunching)
+ {
+ if (launchRequest == null)
+ {
+ throw new ArgumentNullException(nameof(launchRequest));
+ }
+
+ var task = new TaskCompletionSource<AppControlResult>();
+ Interop.AppControl.ErrorCode err;
+ int requestId = 0;
+
+ lock (s_resultNativeCallbackMaps)
+ {
+ requestId = s_reaustId++;
+ s_resultNativeCallbackMaps[requestId] = (handle, result, userData) =>
+ {
+ task.SetResult((AppControlResult)result);
+ lock (s_resultNativeCallbackMaps)
+ {
+ s_resultNativeCallbackMaps.Remove((int)userData);
+ }
+ };
+ }
+
+ if (replyAfterLaunching != null)
+ {
+ lock (s_replyCallbackMaps)
+ {
+ s_replyCallbackMaps[requestId] = replyAfterLaunching;
+ }
+ err = Interop.AppControl.SendLaunchRequestAsync(launchRequest.SafeAppControlHandle, s_resultNativeCallbackMaps[requestId], s_replyNativeCallback, (IntPtr)requestId);
+ }
+ else
+ {
+ err = Interop.AppControl.SendLaunchRequestAsync(launchRequest.SafeAppControlHandle, s_resultNativeCallbackMaps[requestId], null, (IntPtr)requestId);
+ }
+
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ switch (err)
+ {
+ case Interop.AppControl.ErrorCode.InvalidParameter:
+ throw new ArgumentException("Invalid Arguments");
+ case Interop.AppControl.ErrorCode.AppNotFound:
+ throw new Exceptions.AppNotFoundException("App(" + launchRequest.ApplicationId + ") not found. Operation(" + launchRequest.Operation + ")");
+ case Interop.AppControl.ErrorCode.LaunchRejected:
+ throw new Exceptions.LaunchRejectedException("Launch rejected");
+ case Interop.AppControl.ErrorCode.PermissionDenied:
+ throw new Exceptions.PermissionDeniedException("Permission denied");
+
+ default:
+ throw new Exceptions.LaunchRejectedException("Launch rejected");
+ }
+ }
+
+ return task.Task;
+ }
+
+ /// <summary>
+ /// Class for extra data.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ExtraDataCollection
{
private readonly SafeAppControlHandle _handle;
/// <remarks>
/// The function replaces any existing value for the given key.
/// </remarks>
- /// <param name="key">The name of the extra data</param>
- /// <param name="value">The value associated with the given key</param>
- /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string</exception>
- /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with system-defined key</exception>
+ /// <param name="key">The name of the extra data.</param>
+ /// <param name="value">The value associated with the given key.</param>
+ /// <exception cref="ArgumentNullException">Thrown when a key or a value is a zero-length string.</exception>
+ /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with the system-defined key.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// appControl.ExtraData.Add("myKey", "myValue");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Add(string key, string value)
{
if (string.IsNullOrEmpty(key))
/// <remarks>
/// The function replaces any existing value for the given key.
/// </remarks>
- /// <param name="key">The name of the extra data</param>
- /// <param name="value">The value associated with the given key</param>
- /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string</exception>
- /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with system-defined key</exception>
+ /// <param name="key">The name of the extra data.</param>
+ /// <param name="value">The value associated with the given key.</param>
+ /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string.</exception>
+ /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with the system-defined key.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// appControl.ExtraData.Add("myKey", myValues);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Add(string key, IEnumerable<string> value)
{
if (string.IsNullOrEmpty(key))
/// Gets the extra data.
/// </summary>
/// <typeparam name="T">Only string and IEnumerable<string></typeparam>
- /// <param name="key">The name of extra data</param>
- /// <returns>The value associated with the given key</returns>
- /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception>
- /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception>
- /// <exception cref="ArgumentException">Thrown when the key is rejected</exception>
+ /// <param name="key">The name of extra data.</param>
+ /// <returns>The value associated with the given key.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception>
+ /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception>
+ /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
- /// string myValue = appControl.ExtraData.Get<string>("myKey");
+ /// string myValue = appControl.ExtraData.Get<string>("myKey");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public T Get<T>(string key)
{
object ret = Get(key);
/// <summary>
/// Gets the extra data.
/// </summary>
- /// <param name="key">The name of extra data</param>
- /// <returns>The value associated with the given key</returns>
- /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception>
- /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception>
- /// <exception cref="ArgumentException">Thrown when the key is rejected</exception>
+ /// <param name="key">The name of extra data.</param>
+ /// <returns>The value associated with the given key.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception>
+ /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception>
+ /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public object Get(string key)
{
if (IsCollection(key))
/// <summary>
/// Gets all keys in extra data.
/// </summary>
- /// <returns>The keys in the AppControl</returns>
- /// <exception cref="InvalidOperationException">Thrown when invalid parameter</exception>
+ /// <returns>The keys in the AppControl.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when the key is an invalid parameter.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
- /// IEnumerable<string> keys = appControl.GetKeys();
+ /// IEnumerable<string> keys = appControl.GetKeys();
/// if (keys != null)
/// {
/// foreach (string key in keys)
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<string> GetKeys()
{
List<string> keys = new List<string>();
/// <summary>
/// Tries getting the extra data.
/// </summary>
- /// <param name="key">The name of extra data</param>
- /// <param name="value">The value associated with the given key</param>
- /// <returns>The result whether getting the value is done</returns>
- /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception>
- /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception>
- /// <exception cref="ArgumentException">Thrown when the key is rejected</exception>
+ /// <param name="key">The name of extra data.</param>
+ /// <param name="value">The value associated with the given key.</param>
+ /// <returns>The result whether getting the value is done.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception>
+ /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception>
+ /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public bool TryGet(string key, out string value)
{
if (string.IsNullOrEmpty(key))
/// <summary>
/// Tries getting the extra data.
/// </summary>
- /// <param name="key">The name of extra data</param>
- /// <param name="value">The value associated with the given key</param>
- /// <returns>The result whether getting the value is done</returns>
- /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception>
- /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception>
- /// <exception cref="ArgumentException">Thrown when the key is rejected</exception>
+ /// <param name="key">The name of extra data.</param>
+ /// <param name="value">The value associated with the given key.</param>
+ /// <returns>The result whether getting the value is done.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception>
+ /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception>
+ /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
- /// IEnumerable<string> myValue = null;
+ /// IEnumerable<string> myValue = null;
/// bool result = appControl.ExtraData.TryGet("myKey", out myValue);
/// if (result)
/// {
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public bool TryGet(string key, out IEnumerable<string> value)
{
if (string.IsNullOrEmpty(key))
/// <summary>
/// Removes the extra data.
/// </summary>
- /// <param name="key">The name of the extra data</param>
- /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string</exception>
- /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception>
- /// <exception cref="ArgumentException">Thrown when the key is rejected</exception>
+ /// <param name="key">The name of the extra data.</param>
+ /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string.</exception>
+ /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception>
+ /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// appControl.ExtraData.Remove("myKey");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Remove(string key)
{
if (string.IsNullOrEmpty(key))
/// <summary>
/// Counts keys in the extra data.
/// </summary>
- /// <returns>The number of counting keys</returns>
- /// <exception cref="InvalidOperationException">Thrown when invalid parameter</exception>
+ /// <returns>The number of counting keys.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when the key is an invalid parameter.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// int numberOfKeys = appControl.ExtraData.Count();
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public int Count()
{
return GetKeys().Count();
}
/// <summary>
- /// Checks whether the extra data associated with the given key is of collection data type.
+ /// Checks whether the extra data associated with the given key is of the collection data type.
/// </summary>
- /// <param name="key">The name of the extra data</param>
- /// <returns>If true the extra data is of array data type, otherwise false</returns>
- /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string</exception>
- /// <exception cref="InvalidOperationException">Thrown when failed to check the key</exception>
+ /// <param name="key">The name of the extra data.</param>
+ /// <returns>If true, the extra data is of the array data type, otherwise false.</returns>
+ /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when failed to check the key.</exception>
/// <example>
/// <code>
/// AppControl appControl = new AppControl();
/// bool result = appControl.ExtraData.IsCollection("myKey");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public bool IsCollection(string key)
{
if (string.IsNullOrEmpty(key))
projects / platform / core / csapi / tizenfx.git / blobdiff