Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

C# API

method libtmux-dotnet latest

Pane.DisplayMessageAsync

Namespace LibTmux.Pane.DisplayMessageAsync LibTmux

Shows a message on the client viewing this pane.

View as Markdown

Source and package
Module
LibTmux
Declared in
Pane
Package
LibTmux
Source
src/LibTmux/Pane.Display.cs
Other languages
Python Ruby Lua TypeScriptRustGo 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
Returns

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

In other ports Show a message on the client viewing a pane
Esc

Type to search.