3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM IM records.
31 * @package CiviCRM_APIv3
35 * Add an IM for a contact.
37 * @param array $params
41 function civicrm_api3_im_create($params) {
42 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Im');
46 * Adjust Metadata for Create action.
48 * The metadata is used for setting defaults, documentation & validation.
50 * @param array $params
51 * Array of parameters determined by getfields.
53 function _civicrm_api3_im_create_spec(&$params) {
54 $params['contact_id']['api.required'] = 1;
58 * Deletes an existing IM.
60 * @param array $params
65 function civicrm_api3_im_delete($params) {
66 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
70 * Retrieve one or more IM.
72 * @param array $params
73 * An associative array of name/value pairs.
78 function civicrm_api3_im_get($params) {
79 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);