ActionSchedule.php
This api exposes CiviCRM Scheduled Reminders.
Table of Contents
Functions
- civicrm_api3_action_schedule_get() : array<string|int, mixed>
- Get CiviCRM ActionSchedule details.
- civicrm_api3_action_schedule_create() : array<string|int, mixed>
- Create a new ActionSchedule.
- _civicrm_api3_action_schedule_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_action_schedule_delete() : array<string|int, mixed>
- Delete an existing ActionSchedule.
Functions
civicrm_api3_action_schedule_get()
Get CiviCRM ActionSchedule details.
civicrm_api3_action_schedule_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_action_schedule_create()
Create a new ActionSchedule.
civicrm_api3_action_schedule_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_action_schedule_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_action_schedule_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_action_schedule_delete()
Delete an existing ActionSchedule.
civicrm_api3_action_schedule_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the action_schedule to be deleted.
Return values
array<string|int, mixed> —API result array