namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the Complication class for the watch application which using watchface complication.
+ /// Represents the complication for a watch application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public abstract class Complication : IEditable, IDisposable
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the ComplicationProvider class for the complication provider service application.
+ /// Represents the complication provider for a service application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public abstract class ComplicationProvider : IDisposable
private readonly UpdateRequestedCallback _updatedCallback;
/// <summary>
- /// Initializes the ComplicationProvider class.
+ /// Initializes a new instance of the ComplicationProvider class.
/// </summary>
/// <param name="providerId">The id of the complication provider.</param>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
}
/// <summary>
- /// Overrides this method to handle the behavior when the complication data update request event comes from watchface complication.
+ /// Overrides this method to handle the behavior when the event for requesting the update of complication data comes from watchface complication.
/// </summary>
- /// <param name="reqestAppId">The application ID of application which sent update request.</param>
+ /// <param name="reqestAppId">The ID of application which sent update request.</param>
/// <param name="type">The requested type.</param>
/// <param name="contextData">The complication's context which is set by complication setup application.</param>
/// <returns>The requested ComplicationData</returns>
/// <summary>
/// Gets the received event type.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when the invalid parameter is passed.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
}
/// <summary>
- /// Gets the received event target provider ID.
+ /// Gets the provider ID of appcontrol that raises the event.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
}
/// <summary>
- /// Gets the received event target complication type.
+ /// Gets the complication type of the received appcontrol.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
}
/// <summary>
- /// Gets the received event target complication context.
+ /// Gets the complication context of appcontrol that raises the event.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
}
/// <summary>
- /// Releases the unmanaged resources used by the ComplicationProvider class specifying whether to perform a normal dispose operation.
+ /// Releases the unmanaged resources used by the ComplicationProvider instance specifying whether to perform a normal dispose operation.
/// </summary>
/// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the ComplicationProviderSetup class for the complication provider setup application.
+ /// Represents the complication setup for a setup application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public static class ComplicationProviderSetup
{
/// <summary>
- /// Gets the received appctrl containing inforamtion about edit.
+ /// Gets the received appcontrol containing information about edit.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
/// <summary>
/// Replies the setup context to the editor
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <param name="context">The context created by complication setup app.</param>
/// <privilege>http://tizen.org/privilege/datasharing</privilege>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <summary>
/// Gets complication's setup context.
/// </summary>
- /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+ /// <param name="recvAppCtrl">The received appcontrol.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the DesignElement class for the watch application.
+ /// Represents the design element for a watch application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public abstract class DesignElement : IEditable
private int _editableId;
/// <summary>
- /// Initializes the DesignElement class.
+ /// Initializes a new instance of the DesignElement class.
/// </summary>
/// <param name="candidates">The candidates list.</param>
- /// <param name="currentDataIndex">The currently selected data index of candidate list.</param>
+ /// <param name="currentDataIndex">The index of selected data among candidate list.</param>
/// <param name="editableName">The design element name.</param>
/// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <summary>
/// Gets the editable's currently selected data index of candidate list.
/// </summary>
- /// <returns>The currently selected data index of candidate list.</returns>
+ /// <returns>The index of selected data among candidate list.</returns>
/// <since_tizen> 6 </since_tizen>
int IEditable.GetCurrentDataIndex()
{
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the EditablesContainer class for the watch application.
+ /// Represents the editables container for a watch application.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public abstract class EditablesContainer : IDisposable
}
/// <summary>
- /// Checks the editable with editableId is already exists in edit list.
+ /// Checks whether editableId already exists in edit list.
/// </summary>
/// <param name="editableId">The target editable Id.</param>
- /// <returns>true if the editable is already exists in edit list, otherwise false</returns>
+ /// <returns>true if the editable already exists in edit list, otherwise false</returns>
/// <since_tizen> 6 </since_tizen>
public bool IsExist(int editableId)
{
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
/// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
/// <remarks>
- /// This API loads editable's last current data which is updated by editor application.
+ /// This method loads the last editable data which is updated by editor application.
/// </remarks>
/// <param name="editableId">The id of the editable.</param>
/// <example>
}
/// <summary>
- /// Releases the unmanaged resources used by the EditablesContainer class specifying whether to perform a normal dispose operation.
+ /// Releases the unmanaged resources used by the EditablesContainer class specifying whether or not to perform a normal dispose operation.
/// </summary>
/// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Releases all resources used by the EditablesContainer class.
+ /// Releases all resources used by the EditablesContainer instance.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the Highlight class for the editable.
+ /// Represents the highlight data for an editable.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class Highlight
private ShapeType _type;
/// <summary>
- /// Initializes the Highlight class.
+ /// Initializes a new instance of the Highlight class.
/// </summary>
/// <param name="type">The highlight shape type.</param>
/// <param name="x">The highlight geometry x.</param>
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the IconData class for the Icon type complication.
+ /// Represents the icon data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class IconData : ComplicationData
/// protected override ComplicationData OnDataUpdateRequested(string reqestAppId, ComplicationTypes type, Bundle contextData)
/// {
/// if (type == ComplicationTypes.Icon)
- /// {
+ /// {
/// return new IconData("Icon", "extra");
/// }
/// else if (type == ComplicationTypes.LongText)
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the ImageData class for the Image type complication.
+ /// Represents the image data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class ImageData : ComplicationData
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the LongTextData class for the LongText type complication.
+ /// Represents the long text data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class LongTextData : ComplicationData
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the RangedValueData class for the RangedValue type complication.
+ /// Represents the ranged value data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class RangedValueData : ComplicationData
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the ShortTextData class for the ShortText type complication.
+ /// Represents the short text data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class ShortTextData : ComplicationData
{
/// <summary>
- /// Initializes the ShortTextData class.
+ /// Initializes a new instance of the ShortTextData class.
/// </summary>
/// <param name="shortText">The short text.</param>
/// <param name="iconPath">The icon path.</param>
namespace Tizen.Applications.WatchfaceComplication
{
/// <summary>
- /// Represents the TimeData class for the Time type complication.
+ /// Represents the time data for a complication.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class TimeData : ComplicationData
projects / platform / core / csapi / tizenfx.git / commitdiff