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

ControlModeSubscriptions.SubscribeSessionAsync

Namespace LibTmux

Subscribes to a session-scoped format changing.

View as Markdown

Source and package

Module: LibTmux
Declared in: ControlModeSubscriptions
Package: LibTmux
Source: src/LibTmux/ControlMode/ControlModeSubscriptions.cs

SubscribeSessionAsync ( session : IControlModeSession , name : string , format : string , cancellationToken : CancellationToken ) → Task<IReadOnlyList<string>> methodstatic [source] ¶

Parameters

session ( IControlModeSession ) – The control client to subscribe on.
name ( string ) – The subscription's name, echoed back as the first word of a %subscription-changed notification for it.
format ( string ) – The tmux format to watch, without #{}.
cancellationToken ( CancellationToken ) – Cancels the tmux command.

Returns

The lines tmux printed answering the subscribe command.