WidgetControl.cs

/*
 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System;
using System.Collections.Generic;
using Tizen.Applications;
using System.Runtime.InteropServices;

namespace Tizen.Applications
{
    /// <summary>
    /// The class for receiving widget events and sending data to the widget.
    /// </summary>
    /// <since_tizen> 3 </since_tizen>
    public class WidgetControl : IDisposable
    {
        private const string LogTag = "Tizen.Applications.WidgetControl";
        private static Interop.WidgetService.LifecycleCallback _onLifecycleCallback;
        /// <summary>
        /// Class for the widget instance.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public class Instance
        {
            private string _widgetId;

            internal Instance(string widgetId)
            {
                _widgetId = widgetId;
            }

            /// <summary>
            /// The widget ID.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public string Id { get; internal set; }

            /// <summary>
            /// Gets the widget content.
            /// </summary>
            /// <returns>The bundle containing widget content.</returns>
            /// <since_tizen> 3 </since_tizen>
            /// <feature>http://tizen.org/feature/shell.appwidget</feature>
            /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
            /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
            public Bundle GetContent()
            {
                IntPtr h;

                Interop.WidgetService.ErrorCode err = Interop.WidgetService.GetContent(_widgetId, Id, out h);

                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.InvalidParameter:
                        throw new InvalidOperationException("Invalid parameter at unmanaged code");
                    case Interop.WidgetService.ErrorCode.IoError:
                        throw new InvalidOperationException("Failed to access DB");
                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }

                return new Bundle(new SafeBundleHandle(h, true));
            }

            /// <summary>
            /// Changes the content for the widget instance.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            /// <param name="content">Content to be changed.</param>
            /// <param name="force"> True if you want to update your widget even if the provider is paused, otherwise false.</param>
            /// <feature>http://tizen.org/feature/shell.appwidget</feature>
            /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
            /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
            /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
            /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
            public void ChangeContent(Bundle content, bool force)
            {
                Interop.WidgetService.ErrorCode err = Interop.WidgetService.UpdateContent(_widgetId, Id, content.SafeBundleHandle, force ? 1 : 0);

                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.InvalidParameter:
                        throw new ArgumentException("Invalid parameter");

                    case Interop.WidgetService.ErrorCode.Canceled:
                        throw new InvalidOperationException("Provider is paused, so this update request is canceld");

                    case Interop.WidgetService.ErrorCode.OutOfMemory:
                        throw new InvalidOperationException("Out-of-memory at unmanaged code");

                    case Interop.WidgetService.ErrorCode.Fault:
                        throw new InvalidOperationException("Failed to create a request packet");

                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }
            }

            /// <summary>
            /// Changes the update period for the widget instance.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            /// <param name="period">The period to be changed.</param>
            /// <feature>http://tizen.org/feature/shell.appwidget</feature>
            /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
            /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
            /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
            /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
            public void ChangePeriod(double period)
            {
                Interop.WidgetService.ErrorCode err = Interop.WidgetService.ChangePeriod(_widgetId, Id, period);

                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.InvalidParameter:
                        throw new ArgumentException("Invalid parameter");

                    case Interop.WidgetService.ErrorCode.OutOfMemory:
                        throw new InvalidOperationException("Out-of-memory at unmanaged code");

                    case Interop.WidgetService.ErrorCode.Fault:
                        throw new InvalidOperationException("Failed to create a request packet");

                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }
            }
        }

        /// <summary>
        /// The class for the widget size information.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public class Scale
        {

            internal Scale()
            {
            }

            /// <summary>
            /// Enumeration for the types of widget size.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public enum SizeType : int
            {
                /// <summary>
                /// 175x175 based on 720x1280 resolution.
                /// </summary>
                Basic1x1 = 0x0001,

                /// <summary>
                /// 354x175 based on 720x1280 resolution.
                /// </summary>
                Basic2x1 = 0x0002,

                /// <summary>
                /// 354x354 based on 720x1280 resolution.
                /// </summary>
                Basic2x2 = 0x0004,

                /// <summary>
                /// 712x175 based on 720x1280 resolution.
                /// </summary>
                Basic4x1 = 0x0008,

                /// <summary>
                /// 712x354 based on 720x1280 resolution.
                /// </summary>
                Basic4x2 = 0x0010,

                /// <summary>
                /// 712x533 based on 720x1280 resolution.
                /// </summary>
                Basic4x3 = 0x0020,

                /// <summary>
                /// 712x712 based on 720x1280 resolution.
                /// </summary>
                Basic4x4 = 0x0040,

                /// <summary>
                /// 712x891 based on 720x1280 resolution.
                /// </summary>
                Basic4x5 = 0x0080,

                /// <summary>
                /// 712x1070 based on 720x1280 resolution.
                /// </summary>
                Basic4x6 = 0x0100,


                /// <summary>
                /// 224x215 based on 720x1280 resolution.
                /// </summary>
                Easy1x1 = 0x1000,

                /// <summary>
                /// 680x215 based on 720x1280 resolution.
                /// </summary>
                Easy1x2 = 0x2000,

                /// <summary>
                /// 680x653 based on 720x1280 resolution.
                /// </summary>
                Easy1x3 = 0x4000,

                /// <summary>
                /// 720x1280 based on 720x1280 resolution.
                /// </summary>
                Full = 0x0800,
            }

            /// <summary>
            /// Widget width.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public int Width { get; internal set; }

            /// <summary>
            ///Widget height.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public int Height { get; internal set; }

            /// <summary>
            /// The path for the widget preview image file.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public string PreviewImagePath { get; internal set; }

            /// <summary>
            /// The size type of the widget.
            /// </summary>
            /// <since_tizen> 3 </since_tizen>
            public SizeType Type { get; internal set; }
        }

        private event EventHandler<WidgetLifecycleEventArgs> _created;
        private event EventHandler<WidgetLifecycleEventArgs> _resumed;
        private event EventHandler<WidgetLifecycleEventArgs> _paused;
        private event EventHandler<WidgetLifecycleEventArgs> _destroyed;
        private bool _disposedValue = false;
        private static IDictionary<string, int> s_lifecycleEventRefCnt = new Dictionary<string, int>();
        private static IList<WidgetControl> s_eventObjects = new List<WidgetControl>();

        /// <summary>
        /// Factory method for the WidgetControl.
        /// It will create all the objects of WidgetControl based on the package ID.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="pkgId">Package ID.</param>
        /// <returns>The widget control array.</returns>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public static WidgetControl[] CreateAll(string pkgId)
        {
            List<WidgetControl> list = new List<WidgetControl>();

            Interop.WidgetService.ErrorCode err = Interop.WidgetService.GetWidgetListByPkgId(pkgId, (widgetId, isPrime, userData) =>
            {
                list.Add(new WidgetControl(widgetId));
            }, IntPtr.Zero);

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.InvalidParameter:
                    throw new ArgumentException("Invalid parameter");

                case Interop.WidgetService.ErrorCode.IoError:
                    throw new InvalidOperationException("Failed to access DB");

                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException("Not supported");
            }

            return list.ToArray();
        }

        /// <summary>
        /// Gets all the widget IDs by the package ID.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="pkgId">Package ID.</param>
        /// <returns>The widget id array.</returns>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public static string[] GetWidgetIds(string pkgId)
        {
            List<string> list = new List<string>();

            Interop.WidgetService.ErrorCode err = Interop.WidgetService.GetWidgetListByPkgId(pkgId, (widgetId, isPrime, userData) =>
            {
                list.Add(widgetId);
            }, IntPtr.Zero);

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.InvalidParameter:
                    throw new ArgumentException("Invalid parameter");

                case Interop.WidgetService.ErrorCode.IoError:
                    throw new InvalidOperationException("Failed to access DB");

                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException("Not supported");
            }

            return list.ToArray();
        }

        /// <summary>
        /// Gets main appid of the widget.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public string MainAppId
        {
            get
            {
                string str = Interop.WidgetService.GetWidgetMainAppId(Id);
                Interop.WidgetService.ErrorCode err =
                    (Interop.WidgetService.ErrorCode)Internals.Errors.ErrorFacts.GetLastResult();
                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }

                return str;
            }
        }

        /// <summary>
        /// Gets package ID of the widget.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public string PackageId
        {
            get
            {
                string str = Interop.WidgetService.GetWidgetPackageId(Id);
                Interop.WidgetService.ErrorCode err =
                    (Interop.WidgetService.ErrorCode)Internals.Errors.ErrorFacts.GetLastResult();
                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }

                return str;
            }
        }

        /// <summary>
        /// The widget ID.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public string Id { get; internal set; }

        /// <summary>
        /// The flag value for "nodisplay".
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public bool IsNoDisplay
        {
            get
            {
                int ret = Interop.WidgetService.GetNoDisplay(Id);
                Interop.WidgetService.ErrorCode err =
                    (Interop.WidgetService.ErrorCode)Internals.Errors.ErrorFacts.GetLastResult();
                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException("Not supported");
                }

                if (ret != 0)
                    return true;

                return false;
            }
        }

        /// <summary>
        ///  The event handler for a created widget instance.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public event EventHandler<WidgetLifecycleEventArgs> Created
        {
            add
            {
                RegisterLifecycleEvent();
                _created += value;
            }
            remove
            {
                _created -= value;
                UnregisterLifecycleEvent();
            }
        }

        /// <summary>
        /// The event handler for a resumed widget instance.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public event EventHandler<WidgetLifecycleEventArgs> Resumed
        {
            add
            {
                RegisterLifecycleEvent();
                _resumed += value;
            }
            remove
            {
                _resumed -= value;
                UnregisterLifecycleEvent();
            }
        }

        /// <summary>
        /// The event handler for a paused widget instance.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public event EventHandler<WidgetLifecycleEventArgs> Paused
        {
            add
            {
                RegisterLifecycleEvent();
                _paused += value;
            }
            remove
            {
                _paused -= value;
                UnregisterLifecycleEvent();
            }
        }

        /// <summary>
        /// The event handler for a destroyed widget instance.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public event EventHandler<WidgetLifecycleEventArgs> Destroyed
        {
            add
            {
                RegisterLifecycleEvent();
                _destroyed += value;
            }
            remove
            {
                _destroyed -= value;
                UnregisterLifecycleEvent();
            }
        }

        /// <summary>
        /// The constructor of the WidgetControl object.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="widgetId">Widget ID.</param>
        public WidgetControl(string widgetId)
        {
            Id = widgetId;
        }

        /// <summary>
        /// Finalizer of the WidgetControl class.
        /// </summary>
        ~WidgetControl()
        {
            Dispose(false);
        }

        /// <summary>
        /// Gets the objects for widget instance information.
        /// </summary>
        /// <returns>The instances list.</returns>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="NotSupportedException">Thrown when the API is not supported in this device.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        public IEnumerable<Instance> GetInstances()
        {
            IList<Instance> instances = new List<Instance>();
            Interop.WidgetService.ErrorCode err = Interop.WidgetService.GetInstances(Id, (widgetId, instanceId, userData) =>
            {
                instances.Add(new Instance(widgetId) { Id = instanceId });
            }, IntPtr.Zero);

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.InvalidParameter:
                    throw new InvalidOperationException("Invalid parameter at unmanaged code");

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException();

                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();
            }

            return instances;
        }

        /// <summary>
        /// Gets the objects for widget scale information.
        /// </summary>
        /// <returns>The scales list.</returns>
        /// <since_tizen> 3 </since_tizen>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public IEnumerable<Scale> GetScales()
        {
            IntPtr wPtr;
            IntPtr hPtr;
            IntPtr typesPtr;
            int[] w;
            int[] h;
            int[] types;
            int cnt1 = 100;
            int cnt2 = 100;
            IList<Scale> scales = new List<Scale>();
            Interop.WidgetService.ErrorCode err = Interop.WidgetService.GetSupportedSizes(Id, ref cnt1, out wPtr, out hPtr);

            if (cnt1 == 0)
            {
                Log.Error(LogTag, "No supported size :" + Id);
                return null;
            }

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.InvalidParameter:
                    throw new InvalidOperationException("Invalid parameter at unmanaged code");

                case Interop.WidgetService.ErrorCode.IoError:
                    throw new InvalidOperationException("Failed to access DB");

                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException();
            }
            w = new int[cnt1];
            Marshal.Copy(wPtr, w, 0, cnt1);
            Interop.Libc.Free(wPtr);

            h = new int[cnt1];
            Marshal.Copy(hPtr, h, 0, cnt1);
            Interop.Libc.Free(hPtr);

            err = Interop.WidgetService.GetSupportedSizeTypes(Id, ref cnt2, out typesPtr);
            switch (err)
            {
                case Interop.WidgetService.ErrorCode.InvalidParameter:
                    throw new InvalidOperationException("Invalid parameter at unmanaged code");

                case Interop.WidgetService.ErrorCode.IoError:
                    throw new InvalidOperationException("Failed to access DB");

                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();
            }

            if (cnt1 != cnt2)
            {
                Log.Error(LogTag, "Count not match cnt1 :" + cnt1 + ", cnt2 :" + cnt2);
                return null;
            }

            types = new int[cnt2];
            Marshal.Copy(typesPtr, types, 0, cnt2);
            Interop.Libc.Free(typesPtr);

            for (int i = 0; i < cnt1; i++)
            {
                string prev = Interop.WidgetService.GetPreviewImagePath(Id, types[i]);

                scales.Add(new Scale()
                {
                    Width = w[i],
                    Height = h[i],
                    PreviewImagePath = prev,
                    Type = (Scale.SizeType)types[i]
                });
            }
            return scales;
        }

        /// <summary>
        /// Gets the widget name.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="lang">Language.</param>
        /// <returns>The widget name.</returns>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="ArgumentNullException">Thrown when the argument is null.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public string GetName(string lang)
        {
            if (lang == null)
                throw new ArgumentNullException();

            string str = Interop.WidgetService.GetName(Id, lang);
            Interop.WidgetService.ErrorCode err =
                    (Interop.WidgetService.ErrorCode)Internals.Errors.ErrorFacts.GetLastResult();

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException();
            }

            return str;
        }

        /// <summary>
        /// Gets the widget icon path.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="lang">Language.</param>
        /// <returns>The widget icon path.</returns>
        /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="ArgumentNullException">Thrown when the argument is null.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public string GetIconPath(string lang)
        {
            if (lang == null)
                throw new ArgumentNullException();

            string pkgId = Interop.WidgetService.GetPkgId(Id);
            string str = Interop.WidgetService.GetIcon(pkgId, lang);
            Interop.WidgetService.ErrorCode err =
                    (Interop.WidgetService.ErrorCode)Internals.Errors.ErrorFacts.GetLastResult();

            switch (err)
            {
                case Interop.WidgetService.ErrorCode.PermissionDenied:
                    throw new UnauthorizedAccessException();

                case Interop.WidgetService.ErrorCode.NotSupported:
                    throw new NotSupportedException();
            }

            return str;
        }

        /// <summary>
        /// Releases all the resources used by the WidgetControl class.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <feature>http://tizen.org/feature/shell.appwidget</feature>
        /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception>
        /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the required privileges to access this method.</exception>
        /// <exception cref="NotSupportedException">Thrown when the required features are not supported.</exception>
        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        private void Dispose(bool disposing)
        {
            if (!_disposedValue)
            {
                if (disposing)
                {
                }

                _created = null;
                _resumed = null;
                _paused = null;
                _destroyed = null;
                UnregisterLifecycleEvent();

                _disposedValue = true;
            }
        }

        private void RegisterLifecycleEvent()
        {
            if (!s_lifecycleEventRefCnt.ContainsKey(Id))
                s_lifecycleEventRefCnt[Id] = 0;

            if (_created != null || _paused != null || _resumed != null || _destroyed != null)
                return;

            if (s_lifecycleEventRefCnt[Id] == 0)
            {
                if (_onLifecycleCallback == null)
                    _onLifecycleCallback = new Interop.WidgetService.LifecycleCallback(OnLifecycleEvent);

                Interop.WidgetService.ErrorCode err = Interop.WidgetService.SetLifecycleEvent(Id, _onLifecycleCallback, IntPtr.Zero);
                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.InvalidParameter:
                        throw new InvalidOperationException("Invalid parameter at unmanaged code");

                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException();
                }
            }

            s_lifecycleEventRefCnt[Id]++;
            s_eventObjects.Add(this);
            Log.Debug(LogTag, "register lifecycle cb " + Id + " [" + s_lifecycleEventRefCnt[Id] + "]");
        }

        private void UnregisterLifecycleEvent()
        {
            if (!s_lifecycleEventRefCnt.ContainsKey(Id))
                return;

            if (s_lifecycleEventRefCnt[Id] <= 0)
                return;

            if (_created != null || _paused != null || _resumed != null || _destroyed != null)
                return;

            if (s_lifecycleEventRefCnt[Id] == 1)
            {
                Interop.WidgetService.ErrorCode err = Interop.WidgetService.UnsetLifecycleEvent(Id, IntPtr.Zero);

                switch (err)
                {
                    case Interop.WidgetService.ErrorCode.InvalidParameter:
                        throw new InvalidOperationException("Invalid parameter at unmanaged code");

                    case Interop.WidgetService.ErrorCode.PermissionDenied:
                        throw new UnauthorizedAccessException();

                    case Interop.WidgetService.ErrorCode.NotExist:
                        throw new InvalidOperationException("Event handler is not exist");

                    case Interop.WidgetService.ErrorCode.NotSupported:
                        throw new NotSupportedException();
                }
                _onLifecycleCallback = null;
            }

            s_eventObjects.Remove(this);
            s_lifecycleEventRefCnt[Id]--;
            Log.Debug(LogTag, "unregister lifecycle cb " + Id + " [" + s_lifecycleEventRefCnt[Id] + "]");
        }

        private static int OnLifecycleEvent(string widgetId, Interop.WidgetService.LifecycleEvent e, string instanceId, IntPtr userData)
        {
            Log.Debug(LogTag, "Lifecycle event : " + instanceId + " [" + e + "]");
            switch (e)
            {
                case Interop.WidgetService.LifecycleEvent.Created:
                    foreach (WidgetControl c in s_eventObjects)
                    {
                        if (c.Id.CompareTo(widgetId) == 0)
                        {
                            c._created?.Invoke(null, new WidgetLifecycleEventArgs()
                            {
                                WidgetId = widgetId,
                                InstanceId = instanceId,
                                Type = WidgetLifecycleEventArgs.EventType.Created
                            });
                        }
                    }
                    break;

                case Interop.WidgetService.LifecycleEvent.Resumed:
                    foreach (WidgetControl c in s_eventObjects)
                    {
                        if (c.Id.CompareTo(widgetId) == 0)
                        {
                            c._resumed?.Invoke(null, new WidgetLifecycleEventArgs()
                            {
                                WidgetId = widgetId,
                                InstanceId = instanceId,
                                Type = WidgetLifecycleEventArgs.EventType.Resumed
                            });
                       }
                    }
                    break;

                case Interop.WidgetService.LifecycleEvent.Paused:
                    foreach (WidgetControl c in s_eventObjects)
                    {
                        if (c.Id.CompareTo(widgetId) == 0)
                        {
                            c._paused?.Invoke(null, new WidgetLifecycleEventArgs()
                            {
                                WidgetId = widgetId,
                                InstanceId = instanceId,
                                Type = WidgetLifecycleEventArgs.EventType.Paused
                            });
                        }
                    }
                    break;

                case Interop.WidgetService.LifecycleEvent.Destroyed:
                    foreach (WidgetControl c in s_eventObjects)
                    {
                        if (c.Id.CompareTo(widgetId) == 0)
                        {
                            c._destroyed?.Invoke(null, new WidgetLifecycleEventArgs()
                            {
                                WidgetId = widgetId,
                                InstanceId = instanceId,
                                Type = WidgetLifecycleEventArgs.EventType.Destroyed
                            });
                        }
                    }
                    break;
            }
            return 0;

        }
    }
}