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 dashboard contacts.
15 * @package CiviCRM_APIv3
19 * Creates/Updates a new Dashboard Contact Entry.
21 * @param array $params
25 function civicrm_api3_dashboard_contact_create($params) {
26 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'DashboardContact');
30 * Gets a CiviCRM Dashlets of Contacts according to parameters.
32 * @param array $params
33 * Array per getfields metadata.
37 function civicrm_api3_dashboard_contact_get($params) {
38 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
42 * Adjust Metadata for Create action.
44 * The metadata is used for setting defaults, documentation & validation.
46 * @param array $fields
47 * Array of fields determined by getfields.
49 function _civicrm_api3_dashboard_contact_create_spec(&$fields) {
50 $fields['dashboard_id']['api.required'] = TRUE;
54 * Delete an existing dashboard-contact.
56 * @param array $params
59 * @throws \API_Exception
61 function civicrm_api3_dashboard_contact_delete($params) {
62 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);