Gravity_Flow_Assignee

Introduction

The Gravity_Flow_Assignee object

Properties

Public PropertyProperty Type
NameString

Methods

Function NameReturn TypeParametersPurpose
get_display_nameStringNoneReturn the assignee display name.
get_editable_fieldsArrayNoneReturn the editable field IDs for this assignee.
get_idStringNoneReturn the assignee ID.
get_keyStringNoneReturn the assignee key.
get_reminder_timestampBoolean / MixedNoneReturns the status timestamp.
get_stepStep / BooleanNoneReturn the step for this assignee.
get_statusBoolean / MixedNoneReturns the status.
get_status_keyStringNoneReturns the status key.
get_status_labelStringNoneReturns the label to be displayed for the assignee on the workflow detail page.
get_status_timestampBoolean / MixedNoneReturns the status timestamp.
get_typeStringNoneReturn the assignee type.
get_userWP_UserNoneReturns the user account for this assignee.
is_current_userBooleanNoneChecks whether the current user (WP or Token auth) is an assignee.
log_eventNone$status (String)
$duration (Integer)
Log an event for the current assignee.
process_statusBoolean / WP_Error$new_status (String)Processes the status update for the assignee.
removeNoneNoneRemove the assignee from the current step by deleting the associated entry meta items.
replace_variablesString$text (String)Override this method to replace merge tags.
* Important: call the parent method first.
* $text = parent::replace_variables( $text );
send_notificationNotification$notification (Notification)Sends a notification to the assignee.
set_reminder_timestampBoolean / IntegerNoneSets the timestamp for the reminder.
update_statusNone$new_assignee_status (String/Boolean)
Processes the status update for the assignee.