using System;
using System.Collections.Generic;
+using System.ComponentModel;
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 the AppControl handle.</exception>
+ /// <since_tizen> 3 </since_tizen>
public AppControl()
{
Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle);
/// </summary>
/// <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)
{
- throw new ArgumentNullException("handle");
+ throw new ArgumentNullException(nameof(handle));
}
- Interop.AppControl.ErrorCode err = Interop.AppControl.DangerousClone(out _handle, handle.DangerousGetHandle());
- if (err != Interop.AppControl.ErrorCode.None)
+ if (handle.IsInvalid)
{
- throw new InvalidOperationException("Failed to clone the appcontrol handle. Err = " + err);
+ throw new ArgumentNullException(nameof(handle), "handle is invalid");
+ }
+
+ bool mustRelease = false;
+ try
+ {
+ handle.DangerousAddRef(ref mustRelease);
+ Interop.AppControl.ErrorCode err = Interop.AppControl.DangerousClone(out _handle, handle.DangerousGetHandle());
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ throw new InvalidOperationException("Failed to clone the appcontrol handle. Err = " + err);
+ }
+ }
+ catch (ObjectDisposedException e)
+ {
+ throw new ArgumentNullException(nameof(handle), e.Message);
+ }
+ finally
+ {
+ if (mustRelease)
+ {
+ handle.DangerousRelease();
+ }
}
}
}
}
- #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)
+ {
+ 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
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
+#pragma warning disable CA1056
public string Uri
+#pragma warning restore CA1056
{
get
{
/// <value>
/// (if the category is null for setter, it clears the previous value.)
/// </value>
+ /// <since_tizen> 3 </since_tizen>
public string Category
{
get
/// Log.Debug(LogTag, "ApplicationId: " + appControl.ApplicationId);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public string ApplicationId
{
get
/// 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.
/// <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)
{
- throw new ArgumentNullException("control");
+ throw new ArgumentNullException(nameof(control));
}
List<string> ids = new List<string>();
/// <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 the application ID given by property ApplicationId MUST be sent.
/// AppControl.SendLaunchRequest(appControl);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendLaunchRequest(AppControl launchRequest)
{
SendLaunchRequest(launchRequest, null);
}
/// <summary>
+ /// Sends the launch request with setting timeout.
+ /// </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/>
+ /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent.<br/>
+ /// It can set receiving timeout interval using timeout parameter.
+ /// If there is an error that is not related to timeout, the error is returned immediately regardless of the timeout value.
+ /// </remarks>
+ /// <param name="launchRequest">The AppControl.</param>
+ /// <param name="timeout">The timeout in milliseconds, the timeout range is 5000 to 30000.</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 appControl = new AppControl();
+ /// appControl.ApplicationId = "org.tizen.calculator";
+ /// AppControl.SendLaunchRequest(appControl, 10000);
+ /// </code>
+ /// </example>
+ /// <since_tizen> 7.5 </since_tizen>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void SendLaunchRequest(AppControl launchRequest, uint timeout)
+ {
+ SendLaunchRequest(launchRequest, timeout, null);
+ }
+
+ /// <summary>
/// Sends the launch request.
/// </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. \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 the application ID given by property ApplicationId MUST be sent.
/// });
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendLaunchRequest(AppControl launchRequest, AppControlReplyCallback replyAfterLaunching)
{
if (launchRequest == null)
{
- throw new ArgumentNullException("launchRequest");
+ throw new ArgumentNullException(nameof(launchRequest));
}
Interop.AppControl.ErrorCode err;
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
{
case Interop.AppControl.ErrorCode.OutOfMemory:
throw new Exceptions.OutOfMemoryException("Out-of-memory");
case Interop.AppControl.ErrorCode.AppNotFound:
- throw new Exceptions.AppNotFoundException("App not found");
+ 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 Exceptions.LaunchRejectedException("Launch rejected");
+ }
+ }
+ }
+
+ /// <summary>
+ /// Sends the launch request with setting timeout
+ /// </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/>
+ /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent.<br/>
+ /// It can set receiving timeout interval using timeout parameter.
+ /// If there is an error that is not related to timeout, the error is returned immediately regardless of the timeout value.
+ /// </remarks>
+ /// <param name="launchRequest">The AppControl.</param>
+ /// <param name="timeout">The timeout in milliseconds, the timeout range is 5000 to 30000.</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. The timeout interval is set by timeout parameter.</exception>
+ /// <privilege>http://tizen.org/privilege/appmanager.launch</privilege>
+ /// <example>
+ /// <code>
+ /// AppControl appControl = new AppControl();
+ /// appControl.ApplicationId = "org.tizen.calculator";
+ /// AppControl.SendLaunchRequest(appControl, 10000, (launchRequest, replyRequest, result) => {
+ /// // ...
+ /// });
+ /// </code>
+ /// </example>
+ /// <since_tizen> 7.5 </since_tizen>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void SendLaunchRequest(AppControl launchRequest, uint timeout, AppControlReplyCallback replyAfterLaunching)
+ {
+ if (launchRequest == null)
+ {
+ throw new ArgumentNullException(nameof(launchRequest));
+ }
+
+ Interop.AppControl.ErrorCode err;
+
+ if (replyAfterLaunching != null)
+ {
+ int id = 0;
+ lock (s_replyCallbackMaps)
+ {
+ id = s_reaustId++;
+ s_replyCallbackMaps[id] = replyAfterLaunching;
+ }
+ err = Interop.AppControl.SendLaunchRequestWithTimeout(launchRequest._handle, timeout, s_replyNativeCallback, (IntPtr)id);
+ }
+ else
+ {
+ err = Interop.AppControl.SendLaunchRequestWithTimeout(launchRequest._handle, timeout, null, IntPtr.Zero);
+ }
+
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ switch (err)
+ {
+ case Interop.AppControl.ErrorCode.InvalidParameter:
+ 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:
/// AppControl.SendTerminateRequest(terminateRequest);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public static void SendTerminateRequest(AppControl terminateRequest)
{
if (terminateRequest == null)
{
- throw new ArgumentNullException("terminateRequest");
+ throw new ArgumentNullException(nameof(terminateRequest));
}
Interop.AppControl.ErrorCode err;
}
/// <summary>
+ /// 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>
+ /// Sets the auto restart.
+ /// </summary>
+ /// <remarks>
+ /// The functionality of this method only applies to the caller application.
+ /// The auto restart cannot be applied to other applications. The application ID set in the AppControl is ignored.
+ /// This method is only available for platform level signed applications.
+ /// </remarks>
+ /// <param name="appControl">The AppControl.</param>
+ /// <exception cref="ArgumentNullException">Thrown when the argument is null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the argument is invalid.</exception>
+ /// <exception cref="Exceptions.PermissionDeniedException">Thrown when the permission is denied.</exception>
+ /// <exception cref="Exceptions.OutOfMemoryException">Thrown when the memory is insufficient.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the memory is insufficient.</exception>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void SetAutoRestart(AppControl appControl)
+ {
+ if (appControl == null)
+ {
+ throw new ArgumentNullException(nameof(appControl));
+ }
+
+ Interop.AppControl.ErrorCode err = Interop.AppControl.SetAutoRestart(appControl.SafeAppControlHandle);
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ switch (err)
+ {
+ case Interop.AppControl.ErrorCode.InvalidParameter:
+ throw new ArgumentException("Invalid arguments");
+ case Interop.AppControl.ErrorCode.PermissionDenied:
+ throw new Exceptions.PermissionDeniedException("Permission denied");
+ case Interop.AppControl.ErrorCode.OutOfMemory:
+ throw new Exceptions.OutOfMemoryException("Out of memory");
+ default:
+ throw new InvalidOperationException("err = " + err);
+ }
+ }
+ }
+
+ /// <summary>
+ /// Unsets the auto restart.
+ /// </summary>
+ /// <remarks>
+ /// The functionality of this method only applies to the caller application.
+ /// This method is only available for platform level signed applications.
+ /// </remarks>
+ /// <exception cref="Exceptions.PermissionDeniedException">Thrown when the permission is denied.</exception>
+ /// <exception cref="Exceptions.OutOfMemoryException">Thrown when the memory is insufficient.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the memory is insufficient.</exception>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static void UnsetAutoRestart()
+ {
+ Interop.AppControl.ErrorCode err = Interop.AppControl.UnsetAutoRestart();
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ switch (err)
+ {
+ case Interop.AppControl.ErrorCode.PermissionDenied:
+ throw new Exceptions.PermissionDeniedException("Permission denied");
+ case Interop.AppControl.ErrorCode.OutOfMemory:
+ throw new Exceptions.OutOfMemoryException("Out of memory");
+ default:
+ throw new InvalidOperationException("err = " + err);
+ }
+ }
+ }
+
+ /// <summary>
+ /// Gets all default applications.
+ /// </summary>
+ /// <returns>ApplicationIds.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception>
+ /// <example>
+ /// <code>
+ /// IEnumerable<string> applicationIds = AppControl.GetDefaultApplicationIds();
+ /// if (applicationIds != null)
+ /// {
+ /// foreach (string id in applicationIds)
+ /// {
+ /// // ...
+ /// }
+ /// }
+ /// </code>
+ /// </example>
+ /// <since_tizen> 11 </since_tizen>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static IEnumerable<string> GetDefaultApplicationIds()
+ {
+ List<string> ids = new List<string>();
+ Interop.AppControl.DefaultApplicationCallback callback = (applicationId, userData) =>
+ {
+ if (applicationId == null)
+ {
+ return false;
+ }
+
+ ids.Add(applicationId);
+ return true;
+ };
+
+ Interop.AppControl.ErrorCode err = Interop.AppControl.ForeachDefaultApplication(callback, IntPtr.Zero);
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ throw new InvalidOperationException("Failed to get default application Ids. err = " + err);
+ }
+
+ return ids;
+ }
+
+ /// <summary>
+ /// Sets the window position.
+ /// </summary>
+ /// <param name="windowPosition">The window position object.</param>
+ /// <exception cref="ArgumentNullException">Thrown when the argument is null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the argument is invalid.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the invalid operation error occurs.</exception>
+ /// <since_tizen> 11 </since_tizen>
+ public void SetWindowPosition(WindowPosition windowPosition)
+ {
+ if (windowPosition == null)
+ {
+ throw new ArgumentNullException(nameof(windowPosition));
+ }
+
+ Interop.AppControl.ErrorCode err = Interop.AppControl.SetWindowPosition(this.SafeAppControlHandle, windowPosition.PositionX, windowPosition.PositionY, windowPosition.Width, windowPosition.Height);
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ if (err == Interop.AppControl.ErrorCode.InvalidParameter)
+ {
+ throw new ArgumentException("Invalid arguments");
+ }
+ else
+ {
+ throw new InvalidOperationException("err = " + err);
+ }
+ }
+ }
+
+ /// <summary>
+ /// Gets the window position.
+ /// </summary>
+ /// <returns>The window position.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when the invalid operation error occurs.</exception>
+ /// <since_tizen> 11 </since_tizen>
+ public WindowPosition GetWindowPosition()
+ {
+ Interop.AppControl.ErrorCode err = Interop.AppControl.GetWindowPosition(this.SafeAppControlHandle, out int x, out int y, out int w, out int h);
+ if (err != Interop.AppControl.ErrorCode.None)
+ {
+ throw new InvalidOperationException("err = " + err);
+ }
+
+ return new WindowPosition(x, y, w, h);
+ }
+
+ /// <summary>
/// Class for extra data.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
+#pragma warning disable CA1034
public class ExtraDataCollection
+#pragma warning restore CA1034
{
private readonly SafeAppControlHandle _handle;
/// appControl.ExtraData.Add("myKey", "myValue");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Add(string key, string value)
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
if (string.IsNullOrEmpty(value))
{
- throw new ArgumentNullException("value");
+ throw new ArgumentNullException(nameof(value));
}
Interop.AppControl.ErrorCode err = Interop.AppControl.AddExtraData(_handle, key, value);
if (err != Interop.AppControl.ErrorCode.None)
/// appControl.ExtraData.Add("myKey", myValues);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Add(string key, IEnumerable<string> value)
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
if (value == null)
{
- throw new ArgumentNullException("value");
+ throw new ArgumentNullException(nameof(value));
}
string[] valueArray = value.ToArray();
Interop.AppControl.ErrorCode err = Interop.AppControl.AddExtraDataArray(_handle, key, valueArray, valueArray.Length);
/// <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);
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public object Get(string key)
{
if (IsCollection(key))
/// <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>();
/// }
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public bool TryGet(string key, out string value)
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
Interop.AppControl.GetExtraData(_handle, key, out value);
if (value != null)
/// <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))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
IntPtr valuePtr = IntPtr.Zero;
int len = -1;
{
IntPtr charArr = Marshal.ReadIntPtr(valuePtr, IntPtr.Size * i);
stringList.Add(Marshal.PtrToStringAnsi(charArr));
- Interop.Libc.Free(charArr);
+ _ = Interop.Libc.Free(charArr);
}
- Interop.Libc.Free(valuePtr);
+ _ = Interop.Libc.Free(valuePtr);
value = stringList;
return true;
}
/// appControl.ExtraData.Remove("myKey");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void Remove(string key)
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
Interop.AppControl.ErrorCode err = Interop.AppControl.RemoveExtraData(_handle, key);
if (err != Interop.AppControl.ErrorCode.None)
/// int numberOfKeys = appControl.ExtraData.Count();
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public int Count()
{
return GetKeys().Count();
/// bool result = appControl.ExtraData.IsCollection("myKey");
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public bool IsCollection(string key)
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
bool isArray = false;
Interop.AppControl.ErrorCode err = Interop.AppControl.IsExtraDataArray(_handle, key, out isArray);
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
string value = string.Empty;
Interop.AppControl.ErrorCode err = Interop.AppControl.GetExtraData(_handle, key, out value);
{
if (string.IsNullOrEmpty(key))
{
- throw new ArgumentNullException("key");
+ throw new ArgumentNullException(nameof(key));
}
IntPtr valuePtr = IntPtr.Zero;
int len = -1;
{
IntPtr charArr = Marshal.ReadIntPtr(valuePtr, IntPtr.Size * i);
valueArray.Add(Marshal.PtrToStringAnsi(charArr));
- Interop.Libc.Free(charArr);
+ _ = Interop.Libc.Free(charArr);
}
- Interop.Libc.Free(valuePtr);
+ _ = Interop.Libc.Free(valuePtr);
}
return valueArray;
}
projects / platform / core / csapi / tizenfx.git / blobdiff