UpdateContactMediaStreamingBehavior

typed block

Enables or disables contact media streaming for a set of participants.

Factories

UpdateContactMediaStreamingBehavior

UpdateContactMediaStreamingBehavior() -> UpdateContactMediaStreamingBehaviorHandle

Construct a fresh UpdateContactMediaStreamingBehavior block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

UpdateContactMediaStreamingBehavior

UpdateContactMediaStreamingBehavior(id: String) -> UpdateContactMediaStreamingBehaviorHandle

Construct a UpdateContactMediaStreamingBehavior block with an operator-supplied id.

ParameterTypeRequiredDescription
idStringyesWire identifier, typically a Connect UUID restored by decompile so round-trips stay byte-stable.

Methods

media_streaming_state

media_streaming_state(value: String) -> UpdateContactMediaStreamingBehaviorHandle

Set the MediaStreamingState parameter. One of "Enabled" or "Disabled". Must be specified statically.

ParameterTypeRequiredDescription
valueStringyesOne of "Enabled" or "Disabled". Must be specified statically.

participants

participants(value: String) -> UpdateContactMediaStreamingBehaviorHandle

Set the Participants parameter. [ A list of participants to include in the stream if enabling the stream, or disable if disabling the stream

ParameterTypeRequiredDescription
valueStringyes[ A list of participants to include in the stream if enabling the stream, or disable if disabling the stream

participant_type

participant_type(value?: String) -> UpdateContactMediaStreamingBehaviorHandle

Set the ParticipantType parameter. The type of participant to stream. Currently, only "Customer" is supported. Must be defined statically.

ParameterTypeRequiredDescription
valueStringnoThe type of participant to stream. Currently, only "Customer" is supported. Must be defined statically.

media_directions

media_directions(value?: String) -> UpdateContactMediaStreamingBehaviorHandle

Set the MediaDirections parameter. A list of the directions of media to include in the stream - "From" and "To". Must be defined statically.

ParameterTypeRequiredDescription
valueStringnoA list of the directions of media to include in the stream - "From" and "To". Must be defined statically.

media_stream_type

media_stream_type(value: String) -> UpdateContactMediaStreamingBehaviorHandle

Set the MediaStreamType parameter. The type of media to enable or disable from the stream. Currently, only "Audio" is supported. Must be defined statically.

ParameterTypeRequiredDescription
valueStringyesThe type of media to enable or disable from the stream. Currently, only "Audio" is supported. Must be defined statically.

next

next(target: Handle) -> UpdateContactMediaStreamingBehaviorHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

ParameterTypeRequiredDescription
targetHandleyesThe block to route to once this block completes successfully.

on_no_matching

on_no_matching(target: Handle) -> UpdateContactMediaStreamingBehaviorHandle

Wire an error transition for NoMatchingError: if no other Error matches.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingError. if no other Error matches.

set_id

set_id(id: String) -> UpdateContactMediaStreamingBehaviorHandle

Override the auto-generated identifier with a specific wire id.

ParameterTypeRequiredDescription
idStringyesWire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

meta_position

meta_position(x: i64, y: i64) -> UpdateContactMediaStreamingBehaviorHandle

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.

ParameterTypeRequiredDescription
xi64yesCanvas X coordinate.
yi64yesCanvas Y coordinate.

set_meta

set_meta(key: String, value: Dynamic) -> UpdateContactMediaStreamingBehaviorHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

ParameterTypeRequiredDescription
keyStringyesWire key name (under Metadata.ActionMetadata[<id>]).
valueDynamicyesAny JSON-serializable Rhai value.

overwrite_meta

overwrite_meta(value: Map) -> UpdateContactMediaStreamingBehaviorHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

ParameterTypeRequiredDescription
valueMapyesReplacement map for the entire ActionMetadata sub-object.

set_meta_param

set_meta_param(param: String, flag: String, value: Dynamic) -> UpdateContactMediaStreamingBehaviorHandle

Set a single per-parameter ActionMetadata flag.

ParameterTypeRequiredDescription
paramStringyesParameter name (e.g. "Text").
flagStringyesFlag name ("useDynamic", "MFLAG_*", etc.).
valueDynamicyesFlag value.

overwrite_meta_param

overwrite_meta_param(param: String, value: Map) -> UpdateContactMediaStreamingBehaviorHandle

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> UpdateContactMediaStreamingBehaviorHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> UpdateContactMediaStreamingBehaviorHandle

Wire-shape escape hatch for non-canonical transition objects.

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).