Class

SessionRecordingOptionsFluent

ConsoleMonster.Sessions

Namespace: ConsoleMonster.Sessions
Assembly: ConsoleMonster
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

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
SessionRecordingOptionsFluent

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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.SessionRecordingOptions>().IdleLimit(value);

InProcess 2 overloads

public static SessionRecordingOptions InProcess(SessionRecordingOptions sessionRecordingOptions, bool value) #

Sets SessionRecordingOptions.InProcess: Explicitly use the limited in-process PowerShell capture adapter.

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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.SessionRecordingOptions>().RedactionText(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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.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 };    Ui.Options<global::ConsoleMonster.Sessions.SessionRecordingOptions>().WorkingDirectory(value);

Inheritance

Methods

Inherited Methods