RecurringEntity.php
This api exposes CiviCRM recurring entity records.
Table of Contents
Functions
- civicrm_api3_recurring_entity_get() : array<string|int, mixed>
- Retrieve a recurring entity.
- _civicrm_api3_recurring_entity_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_recurring_entity_create() : array<string|int, mixed>
- Add or update a recurring entity.
- _civicrm_api3_recurring_entity_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_recurring_entity_delete() : array<string|int, mixed>
- Deletes an existing ReportInstance.
Functions
civicrm_api3_recurring_entity_get()
Retrieve a recurring entity.
civicrm_api3_recurring_entity_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Return values
array<string|int, mixed>_civicrm_api3_recurring_entity_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_recurring_entity_get_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_recurring_entity_create()
Add or update a recurring entity.
civicrm_api3_recurring_entity_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_recurring_entity_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_recurring_entity_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_recurring_entity_delete()
Deletes an existing ReportInstance.
civicrm_api3_recurring_entity_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>