Dashboard.php
This api exposes CiviCRM Dashboard.
Table of Contents
Functions
- civicrm_api3_dashboard_create() : array<string|int, mixed>
- Creates or updates an Dashlet.
- _civicrm_api3_dashboard_create_spec() : mixed
- Specify Meta data for create.
- civicrm_api3_dashboard_get() : array<string|int, mixed>
- Gets a CiviCRM Dashlets according to parameters.
- civicrm_api3_dashboard_delete() : array<string|int, mixed>
- Delete a specified Dashlet.
Functions
civicrm_api3_dashboard_create()
Creates or updates an Dashlet.
civicrm_api3_dashboard_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —Array containing 'is_error' to denote success or failure and details of the created activity
_civicrm_api3_dashboard_create_spec()
Specify Meta data for create.
_civicrm_api3_dashboard_create_spec(array<string|int, mixed> &$params) : mixed
Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.
Parameters
- $params : array<string|int, mixed>
-
array of parameters determined by getfields.
civicrm_api3_dashboard_get()
Gets a CiviCRM Dashlets according to parameters.
civicrm_api3_dashboard_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_dashboard_delete()
Delete a specified Dashlet.
civicrm_api3_dashboard_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array holding 'id' of dashlet to be deleted.