Skip to content
ConsoleMonster
Class

SessionsFluent

ConsoleMonster.Sessions

Namespace
ConsoleMonster.Sessions
Assembly
ConsoleMonster
Modifiers
static

The fluent methods of SessionRecordingOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • SessionsFluent

Methods

public static SessionRecordingOptions AddArgument(SessionRecordingOptions sessionRecordingOptions, string item) #

Adds an item to SessionRecordingOptions.Arguments: Individual child arguments, quoted by the transport.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
item string required
The item.

Returns

SessionRecordingOptions The same instance.
AddArguments 2 overloads
public static SessionRecordingOptions AddArguments(SessionRecordingOptions sessionRecordingOptions, params string[] items) #

Adds items to SessionRecordingOptions.Arguments: Individual child arguments, quoted by the transport.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
items string[] required
The items, in order.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions AddArguments(SessionRecordingOptions sessionRecordingOptions, IEnumerable<string> items) #

Adds items to SessionRecordingOptions.Arguments: Individual child arguments, quoted by the transport.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

SessionRecordingOptions The same instance.
AddRedact 3 overloads
public static SessionRecordingOptions AddRedact(SessionRecordingOptions sessionRecordingOptions, string item) #

Adds an item to SessionRecordingOptions.Redact: Additional regular expressions, applied before any recording data is written.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
item string required
The item.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions AddRedact(SessionRecordingOptions sessionRecordingOptions, params string[] items) #

Adds items to SessionRecordingOptions.Redact: Additional regular expressions, applied before any recording data is written.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
items string[] required
The items, in order.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions AddRedact(SessionRecordingOptions sessionRecordingOptions, IEnumerable<string> items) #

Adds items to SessionRecordingOptions.Redact: Additional regular expressions, applied before any recording data is written.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions Folder(SessionRecordingOptions sessionRecordingOptions, string value) #

Sets SessionRecordingOptions.Folder: Folder used for automatic recording names. Resolving the default does not probe its availability.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Folder = value };    sessionRecordingOptions.Folder(value);
public static SessionRecordingOptions Height(SessionRecordingOptions sessionRecordingOptions, int value) #

Sets SessionRecordingOptions.Height: Initial terminal height.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value int required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Height = value };    sessionRecordingOptions.Height(value);
public static SessionRecordingOptions IdleLimit(SessionRecordingOptions sessionRecordingOptions, TimeSpan value) #

Sets SessionRecordingOptions.IdleLimit: Asciicast player idle-limit hint. Source timestamps are always preserved; zero disables the hint.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value System.TimeSpan required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { IdleLimit = value };    sessionRecordingOptions.IdleLimit(value);
InProcess 2 overloads
public static SessionRecordingOptions InProcess(SessionRecordingOptions sessionRecordingOptions, bool value) #

Sets SessionRecordingOptions.InProcess: Explicitly capture hosted output through SessionRecorder.CaptureOutput without starting a child terminal. The host owns output forwarding; input and arbitrary Console writes are not intercepted.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value bool required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { InProcess = value };    sessionRecordingOptions.InProcess(value);
public static SessionRecordingOptions InProcess(SessionRecordingOptions sessionRecordingOptions) #

Sets SessionRecordingOptions.InProcess to true.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance to configure.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions MaxBytes(SessionRecordingOptions sessionRecordingOptions, long value) #

Sets SessionRecordingOptions.MaxBytes: Maximum cast bytes, including its header. Capture stops at the limit; the child keeps running.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value long required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { MaxBytes = value };    sessionRecordingOptions.MaxBytes(value);
public static SessionRecordingOptions Path(SessionRecordingOptions sessionRecordingOptions, string? value) #

Sets SessionRecordingOptions.Path: Native asciicast v2 output. Null creates a timestamped name in SessionRecordingOptions.Folder.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string? required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Path = value };    sessionRecordingOptions.Path(value);
public static SessionRecordingOptions RedactionText(SessionRecordingOptions sessionRecordingOptions, string value) #

Sets SessionRecordingOptions.RedactionText: Visible replacement for matched output. The default is [REDACTED]; control characters are not allowed.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                             // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { RedactionText = value };    sessionRecordingOptions.RedactionText(value);
RespondToCursorQueries 2 overloads
public static SessionRecordingOptions RespondToCursorQueries(SessionRecordingOptions sessionRecordingOptions, bool value) #

Sets SessionRecordingOptions.RespondToCursorQueries: Answers cursor-position queries from the tracked VT screen for unattended child sessions. Leave false when forwarding output to a real terminal that supplies its own replies. ConPTY already answers native Windows console queries; the emulation is used only on Unix.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value bool required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                                      // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { RespondToCursorQueries = value };    sessionRecordingOptions.RespondToCursorQueries(value);
public static SessionRecordingOptions RespondToCursorQueries(SessionRecordingOptions sessionRecordingOptions) #

Sets SessionRecordingOptions.RespondToCursorQueries to true.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance to configure.

Returns

SessionRecordingOptions The same instance.
public static SessionRecordingOptions SessionTimeout(SessionRecordingOptions sessionRecordingOptions, TimeSpan? value) #

Sets SessionRecordingOptions.SessionTimeout: Optional maximum child lifetime from startup, including readiness and scripted-input waits. Null preserves the independent wait timeout used by existing callers.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value System.TimeSpan? required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                              // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { SessionTimeout = value };    sessionRecordingOptions.SessionTimeout(value);
public static SessionRecordingOptions Shell(SessionRecordingOptions sessionRecordingOptions, string? value) #

Sets SessionRecordingOptions.Shell: Child executable. Null selects $SHELL on Unix, falling back to zsh on macOS or sh on Linux; Windows uses its platform shell.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string? required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Shell = value };    sessionRecordingOptions.Shell(value);
public static SessionRecordingOptions Timeout(SessionRecordingOptions sessionRecordingOptions, TimeSpan value) #

Sets SessionRecordingOptions.Timeout: Maximum time spent waiting for the child in WaitForExit.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value System.TimeSpan required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Timeout = value };    sessionRecordingOptions.Timeout(value);
public static SessionRecordingOptions Title(SessionRecordingOptions sessionRecordingOptions, string value) #

Sets SessionRecordingOptions.Title: Human-readable recording title.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Title = value };    sessionRecordingOptions.Title(value);
public static SessionRecordingOptions Width(SessionRecordingOptions sessionRecordingOptions, int value) #

Sets SessionRecordingOptions.Width: Initial terminal width.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value int required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { Width = value };    sessionRecordingOptions.Width(value);
public static SessionRecordingOptions WorkingDirectory(SessionRecordingOptions sessionRecordingOptions, string value) #

Sets SessionRecordingOptions.WorkingDirectory: Child working directory.

Parameters

sessionRecordingOptions ConsoleMonster.Sessions.SessionRecordingOptions required
The instance.
value string required
The value.

Returns

SessionRecordingOptions The same instance.

Examples

// C# initializer or property                                                                // C# fluent
new global::ConsoleMonster.Sessions.SessionRecordingOptions { WorkingDirectory = value };    sessionRecordingOptions.WorkingDirectory(value);