This action is primarily used to prevent previous participants on the contact from observing the contact. Common use cases are disconnecting the agent that initiates a transfer when they transfer a contact to a secure destination, or putting the agent on hold when transferring to a quick connect that securely gathers customer input such as credit card numbers.
Factories
UpdatePreviousContactParticipantState
UpdatePreviousContactParticipantState() -> UpdatePreviousContactParticipantStateHandle
Construct a fresh UpdatePreviousContactParticipantState block with an auto-generated id.
Use this when authoring from scratch, the runtime picks a UUID automatically.
UpdatePreviousContactParticipantState
UpdatePreviousContactParticipantState(id: String) -> UpdatePreviousContactParticipantStateHandle
Construct a UpdatePreviousContactParticipantState block with an operator-supplied id.
| Parameter | Type | Required | Description |
id | String | yes | Wire identifier, typically a Connect UUID restored by decompile so round-trips stay byte-stable. |
Methods
previous_contact_participant_state
previous_contact_participant_state(value: String) -> UpdatePreviousContactParticipantStateHandle
Set the PreviousContactParticipantState parameter. One of ["AgentOnHold", "CustomerOnHold", "OffHold"], which are only supported for voice contacts.
| Parameter | Type | Required | Description |
value | String | yes | One of ["AgentOnHold", "CustomerOnHold", "OffHold"], which are only supported for voice contacts. |
next
next(target: Handle) -> UpdatePreviousContactParticipantStateHandle
Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.
| Parameter | Type | Required | Description |
target | Handle | yes | The block to route to once this block completes successfully. |
on_no_matching
on_no_matching(target: Handle) -> UpdatePreviousContactParticipantStateHandle
Wire an error transition for NoMatchingError: if no other Error matches.
| Parameter | Type | Required | Description |
target | Handle | yes | Block to route to on NoMatchingError. if no other Error matches. |
set_id
set_id(id: String) -> UpdatePreviousContactParticipantStateHandle
Override the auto-generated identifier with a specific wire id.
| Parameter | Type | Required | Description |
id | String | yes | Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs. |
meta_position
meta_position(x: i64, y: i64) -> UpdatePreviousContactParticipantStateHandle
Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.
| Parameter | Type | Required | Description |
x | i64 | yes | Canvas X coordinate. |
y | i64 | yes | Canvas Y coordinate. |
set_meta
set_meta(key: String, value: Dynamic) -> UpdatePreviousContactParticipantStateHandle
Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.
| Parameter | Type | Required | Description |
key | String | yes | Wire key name (under Metadata.ActionMetadata[<id>]). |
value | Dynamic | yes | Any JSON-serializable Rhai value. |
overwrite_meta
overwrite_meta(value: Map) -> UpdatePreviousContactParticipantStateHandle
Full-replace escape hatch, overwrite the entire ActionMetadata blob.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement map for the entire ActionMetadata sub-object. |
set_meta_param
set_meta_param(param: String, flag: String, value: Dynamic) -> UpdatePreviousContactParticipantStateHandle
Set a single per-parameter ActionMetadata flag.
| Parameter | Type | Required | Description |
param | String | yes | Parameter name (e.g. "Text"). |
flag | String | yes | Flag name ("useDynamic", "MFLAG_*", etc.). |
value | Dynamic | yes | Flag value. |
overwrite_meta_param
overwrite_meta_param(param: String, value: Map) -> UpdatePreviousContactParticipantStateHandle
Replace the entire flag map for one parameter.
| Parameter | Type | Required | Description |
param | String | yes | Parameter name. |
value | Map | yes | Replacement flag map for the parameter. |
overwrite_parameters
overwrite_parameters(value: Map) -> UpdatePreviousContactParticipantStateHandle
Wire-shape escape hatch, overwrite the entire Parameters blob.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement parameter map for the block. |
raw_transitions
raw_transitions(value: Map) -> UpdatePreviousContactParticipantStateHandle
Wire-shape escape hatch for non-canonical transition objects.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement transitions map (raw JSON shape). |