Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.NET API

LibTmux.Window.DisplayMessageAsync

.NET

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust
Go
Java Unavailable
.NET
C++
Swift Unavailable

View as Markdown

Module: LibTmux
Declared in: Window
Package: LibTmux
Source: src/LibTmux/Window.Display.cs
Other languages: Python Ruby Lua TypeScript Rust Go Java C++ Swift

DisplayMessageAsync ( request : DisplayMessageRequest , cancellationToken : CancellationToken ) → Task<IReadOnlyList<string>?> methodasync [source] ¶ methodasync [source] ¶ DisplayMessageAsync

Shows a message on the client viewing this window.

A message with no client to show it on is not a failure, so tmux's complaint is logged rather than raised.

Parameters

request ( DisplayMessageRequest ) – The message to show.
cancellationToken ( CancellationToken ) – Cancels the tmux command.

Returns

The printed lines when the request asked for them, else null.

Raises

ArgumentException – The request asks to redraw the pane, which only a pane can honour.

In other ports Show a message on the client viewing a window

Python libtmux.Window.display_message
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript no equivalent on Window
Rust window.Window.display
Go tmux.Window.DisplayMessage
Java no equivalent on Window
C++ libtmux::Window::show_message
Swift no equivalent on Window

0 declared, 0 inherited