ActivityType.php
The ActivityType api is deprecated. Please use the OptionValue api instead.
Table of Contents
Functions
- _civicrm_api3_activity_type_deprecation() : string
- Notification of deprecated function.
- civicrm_api3_activity_type_get() : array<string|int, mixed>
- Retrieve activity types.
- civicrm_api3_activity_type_create() : array<string|int, mixed>
- Create activity type.
- _civicrm_api3_activity_type_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_activity_type_delete() : array<string|int, mixed>
- Delete ActivityType.
Functions
_civicrm_api3_activity_type_deprecation()
Notification of deprecated function.
api notice
_civicrm_api3_activity_type_deprecation() : string
Return values
string —to indicate this entire api entity is deprecated
civicrm_api3_activity_type_get()
Retrieve activity types.
- use the getoptions action instead
civicrm_api3_activity_type_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —activity types keyed by id
civicrm_api3_activity_type_create()
Create activity type.
use the OptionValue api instead
civicrm_api3_activity_type_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —created / updated activity type
_civicrm_api3_activity_type_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_activity_type_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_activity_type_delete()
Delete ActivityType.
use OptionValue api
civicrm_api3_activity_type_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array including id of activity_type to delete.
Tags
Return values
array<string|int, mixed> —API result array