api/v3/Im.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  * File for the CiviCRM APIv3 IM functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_IM
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37 /**
  38  *  Add an IM for a contact
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields im_create}
  42  *
  43  * @param array $params
  44  *
  45  * @return array of newly created IM property values.
  46  * @access public
  47  */
  48 function civicrm_api3_im_create($params) {
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action
  54  *
  55  * The metadata is used for setting defaults, documentation & validation
  56  * @param array $params
  57  *   Array or parameters determined by getfields.
  58  */
  59 function _civicrm_api3_im_create_spec(&$params) {
  60   $params['contact_id']['api.required'] = 1;
  61 }
  62
  63 /**
  64  * Deletes an existing IM
  65  *
  66  * @param array $params
  67  * {@getfields im_delete}
  68  *
  69  * @return array API result Array
  70  * @access public
  71  * @todo convert to using Basic delete - BAO function non standard
  72  */
  73 function civicrm_api3_im_delete($params) {
  74   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  75 }
  76
  77 /**
  78  * Retrieve one or more IM
  79  *
  80  * @param mixed[] (reference ) input parameters
  81  * {@getfields im_get}
  82  * @param array $params
  83  *   An associative array of name/value pairs.
  84  *
  85  * @return  array details of found IM
  86  *
  87  * @access public
  88  */
  89 function civicrm_api3_im_get($params) {
  90   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }
  92