internal static partial class Interop
{
/// <summary>
- /// Wrapper class for maintaining names of dependent native libraries.
+ /// The Wrapper class for maintaining names of dependent native libraries.
/// </summary>
internal static partial class Libraries
{
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// Enumeration for the Sync option
+ /// Enumeration for the sync option.
/// </summary>
[Flags]
public enum SyncOption
{
/// <summary>
- /// Sync job will be operated normally
+ /// The sync job will be operated normally.
/// </summary>
None = 0,
/// <summary>
- /// Sync job will be operated as soon as possible
+ /// The sync job will be operated as soon as possible.
/// </summary>
Expedited = 0X01,
/// <summary>
- /// Sync job will not be performed again when it fails
+ /// The sync job will not be performed again when it fails.
/// </summary>
NoRetry = 0X02,
}
/// <summary>
- /// Enumeration for the Sync period
+ /// Enumeration for the sync period.
/// </summary>
public enum SyncPeriod
{
/// <summary>
- /// Sync within 30 minutes
+ /// Sync within 30 minutes.
/// </summary>
ThirtyMin = 0,
/// <summary>
- /// Sync within 1 hour
+ /// Sync within 1 hour.
/// </summary>
OneHour,
/// <summary>
- /// Sync within 2 hours
+ /// Sync within 2 hours.
/// </summary>
TwoHours,
/// <summary>
- /// Sync within 3 hours
+ /// Sync within 3 hours.
/// </summary>
ThreeHours,
/// <summary>
- /// Sync within 6 hours
+ /// Sync within 6 hours.
/// </summary>
SixHours,
/// <summary>
- /// Sync within 12 hours
+ /// Sync within 12 hours.
/// </summary>
TwelveHours,
/// <summary>
- /// Sync within 1 day
+ /// Sync within 1 day.
/// </summary>
OneDay,
}
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// The class contains the delegates to be called upon scheduling a sync operation
+ /// This class contains the delegates to be called upon scheduling a sync operation.
/// </summary>
public class SyncAdapter
{
Interop.Adapter.SyncAdapterCancelSyncCallback _cancelSyncCallback;
/// <summary>
- /// Callback function for Sync Adapter's start sync request
+ /// The callback function for the sync adapter's start sync request.
/// </summary>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
- /// <returns> true if sync operation is success, @c false otherwise. </returns>
+ /// <returns> true if the sync operation is success, @c false otherwise. </returns>
public delegate bool StartSyncCallback(SyncJobData syncParameters);
/// <summary>
- /// Callback function for Sync Adapter's cancel sync request.
+ /// The callback function for the sync adapter's cancel sync request.
/// </summary>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
public delegate void CancelSyncCallback(SyncJobData syncParameters);
/// <summary>
- /// Sets client (Sync Adapter) callback functions
+ /// Sets the client (sync adapter) callback functions.
/// </summary>
- /// <param name="startSyncCb"> A callback function to be called by Sync Manager for performing sync operation. </param>
- /// <param name="cancelSyncCb"> A callback function to be called by Sync Manager for cancelling sync operation. </param>
+ /// <param name="startSyncCb"> A callback function to be called by the sync manager for performing the sync operation. </param>
+ /// <param name="cancelSyncCb"> A callback function to be called by the sync manager for cancelling the sync operation. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API cannot be a sync adapter. </exception>
public void SetSyncEventCallbacks(StartSyncCallback startSyncCb, CancelSyncCallback cancelSyncCb)
}
/// <summary>
- /// Unsets client (Sync Adapter) callback functions
+ /// Unsets the client (sync adapter) callback functions.
/// </summary>
/// <exception cref="System.Exception"> Thrown when sync manager internal error occurs. </exception>
public void UnsetSyncEventCallbacks()
{
/// <summary>
/// The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations.
- /// Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
+ /// The sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
/// </summary>
public static class SyncClient
{
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
static SyncClient()
{
}
/// <summary>
- /// Requests Sync Manager to perform one time sync operation
+ /// Requests the sync manager to perform one time sync operation.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arugments are null. </exception>
- /// <exception cref="InvalidOperationException"> Thrown when the application calling this api doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
+ /// <returns> An unique value which can manage sync jobs. The number of sync job ID is limite as it is less than hundred. </returns>
public static int RequestOnDemandSyncJob(SyncJobData request, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Requests Sync Manager to perform periodic sync operations
+ /// Requests the sync manager to perform periodic sync operations.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="period"> Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="period"> Determines the time interval of the periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee the exact time. The minimum value is 30 minutes. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <privilege>http://tizen.org/privilege/alarm.set</privilege>
- /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception>
+ /// <exception cref="UnauthorizedAccessException"> In case of a privilege not defined. </exception>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns>
public static int AddPeriodicSyncJob(SyncJobData request, SyncPeriod period, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Requests Sync Manager to perform sync operations whenever corresponding DB changed
+ /// Requests the sync manager to perform sync operations whenever the corresponding DB is changed.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
- /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception>
+ /// <exception cref="UnauthorizedAccessException"> In case of a privilege is not defined. </exception>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns>
public static int AddDataChangeSyncJob(SyncJobData request, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Get all the sync jobs registered with the sync manager
+ /// Gets all the sync jobs registered with the sync manager.
/// </summary>
/// <returns>
/// Returns the list of SyncJobData corresponding to sync requests.
}
/// <summary>
- /// Requests Sync Manager to remove corresponding sync job job based on id
+ /// Requests the sync manager to remove the corresponding sync job based on the ID.
/// </summary>
- /// <param name="id"> A unique value of each sync job, it can be used to search specific sync job and remove it. </param>
+ /// <param name="id"> A unique value of each sync job, it can be used to search a specific sync job and remove it. </param>
/// <exception cref="ArgumentException"> Thrown if the input arugments is invalid. </exception>
public static void RemoveSyncJob(int id)
{
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// Class represents information about a sync job request
+ /// This class represents information about the sync job request.
/// </summary>
public class SyncJobData
{
/// <summary>
- /// Represents calendar capability
+ /// Represents the calendar capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the calendar database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string CalendarCapability = "http://tizen.org/sync/capability/calendar";
/// <summary>
- /// Represents contact capability
+ /// Represents the contact capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the contact database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string ContactCapability = "http://tizen.org/sync/capability/contact";
/// <summary>
- /// Represents image capability
+ /// Represents the image capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the image database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string ImageCapability = "http://tizen.org/sync/capability/image";
/// <summary>
- /// Represents video capability
+ /// Represents the video capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the video database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string VideoCapability = "http://tizen.org/sync/capability/video";
/// <summary>
- /// Represents sound capability
+ /// Represents the sound capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the sound database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string SoundCapability = "http://tizen.org/sync/capability/sound";
/// <summary>
- /// Represents music capability
+ /// Represents the music capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the music database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string MusicCapability = "http://tizen.org/sync/capability/music";
/// <summary>
- /// The account instance on which sync operation was requested or @c null in the case of accountless sync operation
+ /// The account instance on which the sync operation was requested or @c null in the case of the accountless sync operation.
/// </summary>
public AccountManager.Account Account { get; set; }
/// <summary>
- /// User data which contains additional information related registered sync job
+ /// User data which contains an additional information related to the registered sync job.
/// </summary>
public Bundle UserData { get; set; }
/// <summary>
- /// A string representing a sync job which has been operated or capability setting to operate data change sync job
+ /// A string representing a sync job which has been operated or capability setting to operate the data change sync job.
/// </summary>
public string SyncJobName { get; set; }
}
/// <summary>
/// Default constructor. Initializes an object of the CellularAuthInformation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public CellularAuthInformation()
{
}
/// <summary>
/// Adds a route to the routing table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="family">The address family.</param>
/// <param name="interfaceName">The name of the network interface.</param>
/// <param name="hostAddress">The IP address of the host.</param>
/// <summary>
/// Removes a route from the routing table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="family">The address family.</param>
/// <param name="interfaceName">The name of network interface.</param>
/// <param name="hostAddress">The IP address of the host.</param>
/// <summary>
/// The DHCP server address. It is only supported for the IPV4 address family.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Server address of the DHCP.</value>
System.Net.IPAddress DhcpServerAddress { get; }
}
* limitations under the License.
*/
+using System;
+
namespace Tizen.Network.Nsd
{
/// <summary>
}
/// <summary>
- /// Gets the result of a specific AP scan.
+ /// Gets the result of ScanSpecificAPAsync(string essid) API.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>A list containing the WiFiAP objects.</returns>
/// <summary>
/// The Received signal strength indication(RSSI).
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Represents Rssi level of WiFi.</value>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
internal static SensorEventStruct IntPtrToEventStruct(IntPtr unmanagedVariable)
{
- SensorEventStruct outStruct = (SensorEventStruct)Marshal.PtrToStructure(unmanagedVariable, typeof(SensorEventStruct));
+ SensorEventStruct outStruct = (SensorEventStruct)Marshal.PtrToStructure<SensorEventStruct>(unmanagedVariable);
return outStruct;
}
}
/// <feature>http://tizen.org/feature/sensor.heart_rate_monitor</feature>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors.
/// <feature>http://tizen.org/feature/sensor.pedometer</feature>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors.
/// <feature>http://tizen.org/feature/sensor.sleep_monitor</feature>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.stationaryActivityDetector"/> class.
+ /// Initializes a new instance of the <see cref="Tizen.Sensor.StationaryActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.walkingActivityDetector"/> class.
+ /// Initializes a new instance of the <see cref="Tizen.Sensor.WalkingActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
projects / platform / core / csapi / tizenfx.git / commitdiff