BaseComponent.cs

/*
 * Copyright (c) 2019 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.ComponentModel;
using System.Threading.Tasks;

namespace Tizen.Applications.ComponentBased.Common
{
    /// <summary>
    /// Represents the base class for components, providing common functionalities for both FrameComponent and ServiceComponent.
    /// </summary>
    /// <remarks>
    /// This class cannot be registered directly by ComponentBased applications.
    /// It serves as a base class to be inherited by other components.
    /// </remarks>
    /// <since_tizen> 6 </since_tizen>
    [Obsolete("This has been deprecated in API14")]
    public abstract class BaseComponent
    {
        internal IntPtr Handle;

        /// <summary>
        /// Occurs when the system memory is low.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<LowMemoryEventArgs> LowMemory;

        /// <summary>
        /// Occurs when the system battery is low.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<LowBatteryEventArgs> LowBattery;

        /// <summary>
        /// Occurs when the system language is chagned.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<LocaleChangedEventArgs> LocaleChanged;

        /// <summary>
        /// Occurs when the region format is changed.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<RegionFormatChangedEventArgs> RegionFormatChanged;

        /// <summary>
        /// Occurs when the device orientation is changed.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<DeviceOrientationEventArgs> DeviceOrientationChanged;

        /// <summary>
        /// Occurs when the device orientation is changed.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<SuspendedStateEventArgs> SuspendedStateChanged;

        /// <summary>
        /// Occurs when the time zone is changed.
        /// </summary>
        /// <since_tizen> 11 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public event EventHandler<TimeZoneChangedEventArgs> TimeZoneChanged;

        /// <summary>
        /// Gets the unique instance ID of the component.
        /// It will be created after OnCreate method is invoked.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public string Id { get; private set; }

        /// <summary>
        /// Gets the ID of the component.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public string ComponentId { get; private set; }

        /// <summary>
        /// Gets the parent application object to which the component belongs.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public ComponentBasedApplication Parent { get; private set; }

        /// <summary>
        /// Finishes the current component.
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public void Finish()
        {
            Interop.CBApplication.ComponentFinish(Handle);
        }

        /// <summary>
        /// A Context Handle
        /// </summary>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        [EditorBrowsable(EditorBrowsableState.Never)]
        public IntPtr ContextHandle
        {
            get
            {
                return Handle;
            }
            set
            {
                Handle = value;
            }
        }

        internal void Bind(IntPtr handle, string compId, string instanceId, ComponentBasedApplication parent)
        {
            Handle = handle;
            Id = instanceId;
            ComponentId = compId;
            Parent = parent;
        }

        /// <summary>
        /// Override this method to handle restoring the previous state of the component.
        /// </summary>
        /// <param name="c">A bundle containing the saved state of the component. It can only be used within the callback. To use it outside, create a copy.</param>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public virtual void OnRestoreContents(Bundle c)
        {
        }

        /// <summary>
        /// Override this method to handle saving the current state of the component.
        /// </summary>
        /// <param name="c">A bundle containing the current state of the component. It can only be used within the callback. To use it outside, create a copy.</param>
        /// <since_tizen> 6 </since_tizen>
        [Obsolete("This has been deprecated in API14")]
        public virtual void OnSaveContent(Bundle c)
        {
        }

        internal void OnLanguageChangedCallback(string language)
        {
            LocaleChanged?.Invoke(this, new LocaleChangedEventArgs(language));
        }

        internal void OnDeviceOrientationChangedCallback(int orientation)
        {
            DeviceOrientationChanged?.Invoke(this, new DeviceOrientationEventArgs((DeviceOrientation)orientation));
        }

        internal void OnLowBatteryCallback(int status)
        {
            LowBattery?.Invoke(this, new LowBatteryEventArgs((LowBatteryStatus)status));
        }

        internal void OnLowMemoryCallback(int status)
        {
            LowMemory?.Invoke(this, new LowMemoryEventArgs((LowMemoryStatus)status));
        }

        internal void OnRegionFormatChangedCallback(string region)
        {
            RegionFormatChanged?.Invoke(this, new RegionFormatChangedEventArgs(region));
        }

        internal void OnSuspendedStateCallback(int state)
        {
            SuspendedStateChanged?.Invoke(this, new SuspendedStateEventArgs((SuspendedState)state));
        }

        internal void OnTimeZoneChangedCallback(string timeZone, string timeZoneId)
        {
            TimeZoneChanged?.Invoke(this, new TimeZoneChangedEventArgs(timeZone, timeZoneId));
        }

        /// <summary>
        /// Sends a launch request asynchronously.
        /// </summary>
        /// <remarks>
        /// Use this method to send a launch request with group mode enabled.
        /// If group mode is not required, you can use SendLaunchRequestAsync() instead.
        /// </remarks>
        /// <param name="control">The AppControl object representing the request details.</param>
        /// <param name="replyAfterLaunching">The callback function to be invoked when the reply is received.</param>
        /// <returns>A task representing the result of the launch request.</returns>
        /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception>
        /// <exception cref="InvalidOperationException">Thrown when there is a failure in setting the component information in the AppControl.</exception>
        /// <exception cref="Exceptions.AppNotFoundException">Thrown when the target application 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>
        [Obsolete("This has been deprecated in API14")]
        public Task<AppControlResult> SendLaunchRequestAsync(AppControl control, AppControlReplyCallback replyAfterLaunching)
        {
            if (control == null)
            {
                throw new ArgumentNullException(nameof(control));
            }

            int ret = Interop.AppControl.SetCallerInstanceId(control.SafeAppControlHandle, Id);
            if (ret != 0)
                throw new InvalidOperationException("Failed to set id");

            return AppControl.SendLaunchRequestAsync(control, replyAfterLaunching);
        }
    }
}