Im.php
This api exposes CiviCRM IM records.
Table of Contents
Functions
- civicrm_api3_im_create() : array<string|int, mixed>
- Add an IM for a contact.
- _civicrm_api3_im_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_im_delete() : array<string|int, mixed>
- Deletes an existing IM.
- civicrm_api3_im_get() : array<string|int, mixed>
- Retrieve one or more IM.
Functions
civicrm_api3_im_create()
Add an IM for a contact.
civicrm_api3_im_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_im_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_im_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_im_delete()
Deletes an existing IM.
civicrm_api3_im_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result Array
civicrm_api3_im_get()
Retrieve one or more IM.
civicrm_api3_im_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value pairs.
Return values
array<string|int, mixed> —details of found IM