//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
{
public:
/**
- * This is the default constructor for this class.
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*
- * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
*/
Alarm(void);
*
* @since 2.0
*
+ * @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @param[in] duetime The time for the alarm to ring
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] duetime The time for the alarm to ring @n
+ * Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG The specified @c duetime is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If this Alarm instance is already registered by this method, exist alarm is cancelled automatically.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks If this %Alarm instance is already registered by this method, the existing alarm is cancelled automatically.
*/
result Set(const Tizen::Base::DateTime& duetime);
/**
* Sets a repeating alarm.
*
- * @since 2.0
+ * @since 2.0
*
+ * @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @param[in] start The time for the alarm to ring first
- * @param[in] period The interval in minutes between consecutive alarm rings
- * @param[in] pEnd The time for the alarm ring to end
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] start The time for the alarm to ring first @n
+ * Any value with a unit that is less than a second is ignored.
+ * @param[in] period The interval in minutes between consecutive alarm rings
+ * @param[in] pEnd The time for the alarm ring to end @n
+ * Any value with a unit that is less than a second is ignored.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. @n If @c pEnd is @c null, the alarm repeats forever.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically.
+ * - If @c pEnd is @c null, the alarm repeats forever.
*/
result Set(const Tizen::Base::DateTime& start, int period, const Tizen::Base::DateTime* pEnd = null);
/**
* Cancels the alarm.
*
- * @since 2.0
+ * @since 2.0
*
+ * @privlevel public
* @privilege %http://tizen.org/privilege/alarm
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Cancel(void);
/**
* Gets the start time for the current instance of %Alarm.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm
- * @remarks If this %Alarm instance is not registered by the Set() method, return value is default value of the Tizen::Base::DateTime class.
+ * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm
+ * @remarks If this %Alarm instance is not registered by the Set() method, the return value is the default value of
+ * the Tizen::Base::DateTime instance.
*/
const Tizen::Base::DateTime GetStartTime(void) const;
/**
* Gets the period of the current instance of %Alarm in minutes.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The period of the current instance of %Alarm in minutes
+ * @return The period of the current instance of %Alarm in minutes
* @remarks If this %Alarm instance is not registered by the Set() method, return value is @c 0.
*/
int GetPeriod(void) const;
*
* @since 2.0
*
- * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
+ * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
* else @c null if the end time has not been set
*/
const Tizen::Base::DateTime* GetEndTime(void) const;
projects / platform / framework / native / appfw.git / blobdiff