Introduction
The Gravity_Flow_Assignee object
Properties
Public Property | Property Type |
---|---|
Name | String |
Methods
Function Name | Return Type | Parameters | Purpose |
---|---|---|---|
get_display_name | String | None | Return the assignee display name. |
get_editable_fields | Array | None | Return the editable field IDs for this assignee. |
get_id | String | None | Return the assignee ID. |
get_key | String | None | Return the assignee key. |
get_reminder_timestamp | Boolean / Mixed | None | Returns the status timestamp. |
get_step | Step / Boolean | None | Return the step for this assignee. |
get_status | Boolean / Mixed | None | Returns the status. |
get_status_key | String | None | Returns the status key. |
get_status_label | String | None | Returns the label to be displayed for the assignee on the workflow detail page. |
get_status_timestamp | Boolean / Mixed | None | Returns the status timestamp. |
get_type | String | None | Return the assignee type. |
get_user | WP_User | None | Returns the user account for this assignee. |
is_current_user | Boolean | None | Checks whether the current user (WP or Token auth) is an assignee. |
log_event | None | $status (String) $duration (Integer) | Log an event for the current assignee. |
process_status | Boolean / WP_Error | $new_status (String) | Processes the status update for the assignee. |
remove | None | None | Remove the assignee from the current step by deleting the associated entry meta items. |
replace_variables | String | $text (String) | Override this method to replace merge tags. * Important: call the parent method first. * $text = parent::replace_variables( $text ); |
send_notification | Notification | $notification (Notification) | Sends a notification to the assignee. |
set_reminder_timestamp | Boolean / Integer | None | Sets the timestamp for the reminder. |
update_status | None | $new_assignee_status (String/Boolean) | Processes the status update for the assignee. |