*/
/**
- * File for the CiviCRM APIv3 for Scheduled Reminders
+ * This api exposes CiviCRM Scheduled Reminders.
*
* @package CiviCRM_APIv3
- * @subpackage API_ActionSchedule
- *
- * @copyright CiviCRM LLC (c) 2004-2014
*/
/**
- * Get CiviCRM Action Schedule details.
+ * Get CiviCRM ActionSchedule details.
*
* @param array $params
*
* @return array
*/
function civicrm_api3_action_schedule_get($params) {
- return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule');
+ return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
}
/**
- * Create a new Action Schedule.
+ * Create a new ActionSchedule.
*
* @param array $params
*
if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
$params['name'] = CRM_Utils_String::munge($params['title']);
}
- return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule');
+ return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule');
}
/**
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_action_schedule_create_spec(&$params) {
$params['title']['api.required'] = TRUE;
}
/**
- * Delete an existing action_schedule.
+ * Delete an existing ActionSchedule.
*
* @param array $params
- * Array containing id of the action_schedule.
- * to be deleted
+ * Array containing id of the action_schedule to be deleted.
*
* @return array
* API result array