DashboardContact.php
This api exposes CiviCRM dashboard contacts.
Table of Contents
Functions
- civicrm_api3_dashboard_contact_create() : array<string|int, mixed>
- Creates/Updates a new Dashboard Contact Entry.
- civicrm_api3_dashboard_contact_get() : array<string|int, mixed>
- Gets a CiviCRM Dashlets of Contacts according to parameters.
- _civicrm_api3_dashboard_contact_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_dashboard_contact_delete() : array<string|int, mixed>
- Delete an existing dashboard-contact.
Functions
civicrm_api3_dashboard_contact_create()
Creates/Updates a new Dashboard Contact Entry.
civicrm_api3_dashboard_contact_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_dashboard_contact_get()
Gets a CiviCRM Dashlets of Contacts according to parameters.
civicrm_api3_dashboard_contact_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed>_civicrm_api3_dashboard_contact_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_dashboard_contact_create_spec(array<string|int, mixed> &$fields) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $fields : array<string|int, mixed>
-
Array of fields determined by getfields.
civicrm_api3_dashboard_contact_delete()
Delete an existing dashboard-contact.
civicrm_api3_dashboard_contact_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>