Add @searchable annotation to denote which API entities should be visible in Search...
[civicrm-core.git] / Civi / Api4 / ActionSchedule.php
CommitLineData
19b53e5b
C
1<?php
2
380f3545
TO
3/*
4 +--------------------------------------------------------------------+
41498ac5 5 | Copyright CiviCRM LLC. All rights reserved. |
380f3545 6 | |
41498ac5
TO
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
380f3545
TO
10 +--------------------------------------------------------------------+
11 */
12
13/**
14 *
15 * @package CRM
ca5cec67 16 * @copyright CiviCRM LLC https://civicrm.org/licensing
380f3545
TO
17 */
18
19
19b53e5b
C
20namespace Civi\Api4;
21
22/**
23 * ActionSchedule Entity.
24 *
25 * This entity exposes CiviCRM schedule reminders, which allows us to send messages (through email or SMS)
26 * to contacts when certain criteria are met. Using this API you can create schedule reminder for
27 * supported entities like Contact, Activity, Event, Membership or Contribution.
28 *
29 * Creating a new ActionSchedule requires at minimum a title, mapping_id and entity_value.
30 *
09815e9c 31 * @searchable false
0493ec47 32 * @see https://docs.civicrm.org/user/en/latest/email/scheduled-reminders/
19b53e5b
C
33 * @package Civi\Api4
34 */
35class ActionSchedule extends Generic\DAOEntity {
36
37}