Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM IM records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
c1a920f1 | 35 | * Add an IM for a contact. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
77b97be7 | 38 | * |
a6c01b45 | 39 | * @return array |
6a488035 TO |
40 | */ |
41 | function civicrm_api3_im_create($params) { | |
42 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
6a488035 | 43 | } |
11e09c59 TO |
44 | |
45 | /** | |
cd5823ae EM |
46 | * Adjust Metadata for Create action. |
47 | * | |
48 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 49 | * |
cf470720 | 50 | * @param array $params |
b081365f | 51 | * Array of parameters determined by getfields. |
6a488035 TO |
52 | */ |
53 | function _civicrm_api3_im_create_spec(&$params) { | |
54 | $params['contact_id']['api.required'] = 1; | |
55 | } | |
56 | ||
57 | /** | |
cd5823ae | 58 | * Deletes an existing IM. |
6a488035 | 59 | * |
cf470720 | 60 | * @param array $params |
6a488035 | 61 | * |
a6c01b45 | 62 | * @return array |
72b3a70c | 63 | * API result Array |
6a488035 TO |
64 | */ |
65 | function civicrm_api3_im_delete($params) { | |
66 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
67 | } | |
68 | ||
69 | /** | |
c1a920f1 | 70 | * Retrieve one or more IM. |
6a488035 | 71 | * |
cf470720 TO |
72 | * @param array $params |
73 | * An associative array of name/value pairs. | |
6a488035 | 74 | * |
a6c01b45 | 75 | * @return array |
72b3a70c | 76 | * details of found IM |
6a488035 TO |
77 | */ |
78 | function civicrm_api3_im_get($params) { | |
79 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
80 | } |