3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM Scheduled Reminders.
15 * @package CiviCRM_APIv3
19 * Get CiviCRM ActionSchedule details.
21 * @param array $params
26 function civicrm_api3_action_schedule_get($params) {
27 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'ActionSchedule');
31 * Create a new ActionSchedule.
33 * @param array $params
37 function civicrm_api3_action_schedule_create($params) {
38 civicrm_api3_verify_one_mandatory($params, NULL, ['start_action_date', 'absolute_date']);
39 if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
40 $params['name'] = CRM_Utils_String
::munge($params['title']);
42 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'ActionSchedule');
46 * Adjust Metadata for Create action.
48 * The metadata is used for setting defaults, documentation & validation.
50 * @param array $params
51 * Array of parameters determined by getfields.
53 function _civicrm_api3_action_schedule_create_spec(&$params) {
54 $params['title']['api.required'] = TRUE;
55 $params['mapping_id']['api.required'] = TRUE;
56 $params['entity_value']['api.required'] = TRUE;
60 * Delete an existing ActionSchedule.
62 * @param array $params
63 * Array containing id of the action_schedule to be deleted.
68 function civicrm_api3_action_schedule_delete($params) {
69 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);