From e43a9841d2f89565768c1d14d9df69750caf7a5c Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 1 Sep 2021 15:25:25 -0700 Subject: [PATCH] (NFC) CaseActivity Msg - Clarify `contactId` vs `clientId` --- CRM/Case/WorkflowMessage/CaseActivity.php | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CRM/Case/WorkflowMessage/CaseActivity.php b/CRM/Case/WorkflowMessage/CaseActivity.php index 166f2a57f2..738f57cd26 100644 --- a/CRM/Case/WorkflowMessage/CaseActivity.php +++ b/CRM/Case/WorkflowMessage/CaseActivity.php @@ -23,20 +23,29 @@ class CRM_Case_WorkflowMessage_CaseActivity extends Civi\WorkflowMessage\Generic const WORKFLOW = 'case_activity'; /** - * The recipient. + * The recipient of the notification. The `{contact.*}` tokens will reference this person. * * Example: ['contact_id' => 123, 'display_name' => 'Bob Roberts', role => 'FIXME'] * * @var array|null * @scope tokenContext, tplParams + * @fkEntity Contact * @required */ public $contact; /** + * The primary contact associated with this case (eg `civicrm_case_contact.contact_id`). + * + * Existing callers are inconsistent about setting this parameter. + * + * By default, CiviCRM allows one client on any given case, and this should reflect + * that contact. However, some systems may enable multiple clients per case. + * This field may not make sense in the long-term. + * * @var int * @scope tplParams as client_id - * @required + * @fkEntity Contact */ public $clientId; -- 2.25.1