Skip to content

Deprecated ComponentBased.Common api #7553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kdk3776 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecated ComponentBased.Common api #7553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions ...zen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// 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;
Expand All @@ -36,67 +37,78 @@ public abstract class BaseComponent
/// 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);
Expand All @@ -106,6 +118,7 @@ public void Finish()
/// A Context Handle
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
Copy link
Copy Markdown
Member

@wiertel wiertel Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's hidden, so there it is not necessary. Still, it's not a problem.

Copy link
Copy Markdown
Member

@JoonghyunCho JoonghyunCho Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed -- since ContextHandle is [EditorBrowsable(Never)], the [Obsolete] attribute is redundant there. The note is appreciated; the author may want to remove it for cleanliness even though it causes no harm.

[EditorBrowsable(EditorBrowsableState.Never)]
public IntPtr ContextHandle
{
Expand All @@ -132,6 +145,7 @@ internal void Bind(IntPtr handle, string compId, string instanceId, ComponentBas
/// </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)
{
}
Expand All @@ -141,6 +155,7 @@ public virtual void OnRestoreContents(Bundle c)
/// </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)
{
}
Expand Down Expand Up @@ -196,6 +211,7 @@ internal void OnTimeZoneChangedCallback(string timeZone, string timeZoneId)
/// <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)
Expand Down
9 changes: 9 additions & 0 deletions ...ions.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// Each component has its own lifecycle, and the framework handles these lifecycles independently.
/// </remarks>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract class ComponentBasedApplication : Application
{
private const string LogTag = "Tizen.Applications";
Expand All @@ -54,6 +55,7 @@ public abstract class ComponentBasedApplication : Application
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public ComponentBasedApplication(IDictionary<Type, string> typeInfo)
{
_callbacks.OnInit = new Interop.CBApplication.CBAppInitCallback(OnInitNative);
Expand Down Expand Up @@ -84,6 +86,7 @@ public ComponentBasedApplication(IDictionary<Type, string> typeInfo)
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public void RegisterComponent(Type compType, string compId)
{
if (_componentFactories.ContainsKey(compType))
Expand Down Expand Up @@ -131,6 +134,7 @@ public void RegisterComponent(Type compType, string compId)
/// </code>
/// </example>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public override void Run(string[] args)
{
base.Run(args);
Expand All @@ -154,6 +158,7 @@ public override void Run(string[] args)
/// Exits the application's main loop.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public override void Exit()
{
Interop.CBApplication.BaseExit();
Expand Down Expand Up @@ -203,6 +208,7 @@ private void OnFinishedNative(IntPtr data)
/// Override this method to handle any initialization logic before the application enters the main event loop.
/// </remarks>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
protected virtual void OnInit(string[] args)
{
}
Expand All @@ -214,6 +220,7 @@ protected virtual void OnInit(string[] args)
/// Override this method to handle any cleanup logic after the application has finished running.
/// </remarks>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
protected virtual void OnFinished()
{
}
Expand All @@ -225,6 +232,7 @@ protected virtual void OnFinished()
/// This is an abstract method that must be implemented by derived classes to define the behavior when the application starts.
/// </remarks>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
protected abstract void OnRun();

/// <summary>
Expand All @@ -234,6 +242,7 @@ protected virtual void OnFinished()
/// Override this method to handle any logic needed before the application exits.
/// </remarks>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
protected virtual void OnExit()
{
}
Expand Down
1 change: 1 addition & 0 deletions ...zen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/DisplayStatus.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// Enumeration for display status.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public enum DisplayStatus
{
/// <summary>
Expand Down
9 changes: 9 additions & 0 deletions ...en.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// This class provides methods for handling the lifecycle and state of UI components.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract class FrameComponent : BaseComponent
{
/// <summary>
Expand All @@ -33,6 +34,7 @@ public abstract class FrameComponent : BaseComponent
/// </value>
/// <exception cref="InvalidOperationException">Thrown when the display status cannot be retrieved.</exception>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public DisplayStatus DisplayStatus
{
get
Expand All @@ -53,6 +55,7 @@ public DisplayStatus DisplayStatus
/// <c>true</c> if the service component is successfully created; otherwise, <c>false</c>.
/// </returns>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract bool OnCreate();

/// <summary>
Expand All @@ -63,6 +66,7 @@ public DisplayStatus DisplayStatus
/// An <see cref="IWindowInfo"/> object that represents the created window.
/// </returns>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract IWindowInfo CreateWindowInfo();

/// <summary>
Expand All @@ -71,6 +75,7 @@ public DisplayStatus DisplayStatus
/// <param name="appControl">The <see cref="AppControl"/> object containing the app control data.</param>
/// <param name="restarted"><c>true</c> if the component was restarted; otherwise, <c>false</c>.</param>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnStart(AppControl appControl, bool restarted)
{
}
Expand All @@ -79,6 +84,7 @@ public virtual void OnStart(AppControl appControl, bool restarted)
/// Called when the component is resumed. Override this method to handle resume behavior.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnResume()
{
}
Expand All @@ -87,6 +93,7 @@ public virtual void OnResume()
/// Called when the component is paused. Override this method to handle pause behavior.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnPause()
{
}
Expand All @@ -95,6 +102,7 @@ public virtual void OnPause()
/// Called when the component is stopped. Override this method to handle stop behavior.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnStop()
{
}
Expand All @@ -103,6 +111,7 @@ public virtual void OnStop()
/// Called when the component is destroyed. Override this method to handle destruction behavior.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnDestroy()
{
}
Expand Down
1 change: 1 addition & 0 deletions ...Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/IWindowInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// Interface for window information
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public interface IWindowInfo : IDisposable
{
/// <summary>
Expand Down
1 change: 1 addition & 0 deletions ...izen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/IWindowProxy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// Proxy for window
/// </summary>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public interface IWindowProxy : IWindowInfo
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions ....Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// This class provides methods for handling the lifecycle and state of service components.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract class ServiceComponent : BaseComponent
{
/// <summary>
Expand All @@ -32,6 +33,7 @@ public abstract class ServiceComponent : BaseComponent
/// <c>true</c> if the service component is successfully created; otherwise, <c>false</c>.
/// </returns>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract bool OnCreate();

/// <summary>
Expand All @@ -40,6 +42,7 @@ public abstract class ServiceComponent : BaseComponent
/// <param name="appControl">The <see cref="AppControl"/> object containing the app control data.</param>
/// <param name="restarted"><c>true</c> if the component was restarted; otherwise, <c>false</c>.</param>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnStartCommand(AppControl appControl, bool restarted)
{
}
Expand All @@ -48,6 +51,7 @@ public virtual void OnStartCommand(AppControl appControl, bool restarted)
/// Called when the service component is destroyed. Override this method to handle destruction behavior.
/// </summary>
/// <since_tizen> 6 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnDestroy()
{
}
Expand Down
8 changes: 8 additions & 0 deletions ...n.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Tizen.Applications.ComponentBased.Common
/// This class provides methods for handling the lifecycle and state of widget components.
/// </summary>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract class WidgetComponent : BaseComponent
{
/// <summary>
Expand All @@ -34,6 +35,7 @@ public abstract class WidgetComponent : BaseComponent
/// <c>true</c> if the widget component is successfully created; otherwise, <c>false</c>.
/// </returns>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract bool OnCreate(int width, int height);

/// <summary>
Expand All @@ -45,6 +47,7 @@ public abstract class WidgetComponent : BaseComponent
/// An <see cref="IWindowProxy"/> object representing the window to use.
/// </returns>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public abstract IWindowProxy CreateWindowInfo(int width, int height);

/// <summary>
Expand All @@ -54,6 +57,7 @@ public abstract class WidgetComponent : BaseComponent
/// <c>true</c> if the component was restarted; otherwise, <c>false</c>.
/// </param>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnStart(bool restarted)
{
}
Expand All @@ -62,6 +66,7 @@ public virtual void OnStart(bool restarted)
/// Called when the widget component is resumed. Override this method to handle resume behavior.
/// </summary>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnResume()
{
}
Expand All @@ -70,6 +75,7 @@ public virtual void OnResume()
/// Called when the widget component is paused. Override this method to handle pause behavior.
/// </summary>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnPause()
{
}
Expand All @@ -78,6 +84,7 @@ public virtual void OnPause()
/// Called when the widget component is stopped. Override this method to handle stop behavior.
/// </summary>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnStop()
{
}
Expand All @@ -89,6 +96,7 @@ public virtual void OnStop()
/// <c>true</c> if the instance is permanent; otherwise, <c>false</c>.
/// </param>
/// <since_tizen> 9 </since_tizen>
[Obsolete("This has been deprecated in API14")]
public virtual void OnDestroy(bool permanent)
{
}
Expand Down
Loading