C# API

method libtmux-dotnet latest

Pane.WaitForTextAsync

Namespace LibTmux

Waits until the pane shows literal text.

Source and package

WaitForTextAsync ( text : string , timeout : TimeSpan , cancellationToken : CancellationToken ) → Task<PaneWaitResult> ( request : PaneWaitRequest , cancellationToken : CancellationToken ) → Task<PaneWaitResult> methodoverload2 overloads [source] ¶

Description#

Text already on screen ends the wait at once as PresentAtEntry . Matching is line by line, so the text cannot span lines.

Parameters

text ( string ) – The text to wait for, matched within a line. (for WaitForTextAsync(text, timeout, cancellationToken))
timeout ( TimeSpan ) – How long to wait. (for WaitForTextAsync(text, timeout, cancellationToken))
cancellationToken ( CancellationToken ) – Stops the wait.
request ( PaneWaitRequest ) – The patterns and time allowed. (for WaitForTextAsync(request, cancellationToken))

Returns

How the wait ended.

Raises

ArgumentException – The text is empty or contains a line break. (for WaitForTextAsync(text, timeout, cancellationToken))
ArgumentOutOfRangeException – The timeout is negative or longer than 49 days.
TmuxTransportException – Control observation failed and polling was not enabled.
TmuxObjectNotFoundException – tmux no longer has the pane when the wait begins.
RegexMatchTimeoutException – A pattern exceeded its own match timeout. (for WaitForTextAsync(request, cancellationToken))