Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

C# API

method libtmux-dotnet latest

Window.DisplayMessageAsync

Namespace LibTmux

Shows a message on the client viewing this window.

View as Markdown

Source and package

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

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

Description#

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
Kotlin No source-verified Kotlin equivalent is recorded for this operation.
Scala No source-verified Scala equivalent is recorded for this operation.
F# No source-verified F# equivalent is recorded for this operation.