<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* APIv3 functions for registering/processing mailing group events.
*
* @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2013
- * $Id$
- *
*/
/**
- * Handle a confirm event
+ * Handle a confirm event.
*
- * @param array $params Associative array of property
- * name/value pairs to insert in new 'survey'
+ * @param array $params
+ * name/value pairs to insert in new 'survey'
*
- * @return array api result array
- * {@getfields mailing_event_confirm_create}
- * @access public
+ * @throws Exception
+ * @return array
+ * api result array
*/
function civicrm_api3_mailing_event_confirm_create($params) {
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
$params['contact_id']['api.required'] = 1;
+ $params['contact_id']['title'] = 'Contact ID';
$params['subscribe_id']['api.required'] = 1;
+ $params['subscribe_id']['title'] = 'Subscribe Event ID';
$params['hash']['api.required'] = 1;
+ $params['hash']['title'] = 'Hash';
}
-