api/v3/Im.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM IM records.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Add an IM for a contact.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  */
  25 function civicrm_api3_im_create($params) {
  26   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Im');
  27 }
  28
  29 /**
  30  * Adjust Metadata for Create action.
  31  *
  32  * The metadata is used for setting defaults, documentation & validation.
  33  *
  34  * @param array $params
  35  *   Array of parameters determined by getfields.
  36  */
  37 function _civicrm_api3_im_create_spec(&$params) {
  38   $params['contact_id']['api.required'] = 1;
  39   $defaultLocation = CRM_Core_BAO_LocationType::getDefault();
  40   if ($defaultLocation) {
  41     $params['location_type_id']['api.default'] = $defaultLocation->id;
  42   }
  43 }
  44
  45 /**
  46  * Deletes an existing IM.
  47  *
  48  * @param array $params
  49  *
  50  * @return array
  51  *   API result Array
  52  */
  53 function civicrm_api3_im_delete($params) {
  54   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  55 }
  56
  57 /**
  58  * Retrieve one or more IM.
  59  *
  60  * @param array $params
  61  *   An associative array of name/value pairs.
  62  *
  63  * @return array
  64  *   details of found IM
  65  */
  66 function civicrm_api3_im_get($params) {
  67   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  68 }