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

TmuxHooks.SetAsync

Namespace LibTmux

Sets one hook entry.

View as Markdown

Source and package

Module: LibTmux
Declared in: TmuxHooks
Package: LibTmux
Source: src/LibTmux/Hooks/TmuxHooks.cs

SetAsync ( request : SetHookRequest , cancellationToken : CancellationToken ) → Task<TmuxHook> ( request : SetHooksRequest , cancellationToken : CancellationToken ) → Task<TmuxHook> methodasyncoverload2 overloads [source] ¶

Parameters

request ( SetHookRequest ) – Which hook to set, to what, and how. (for SetAsync(request, cancellationToken) [overload 1])
cancellationToken ( CancellationToken ) – Cancels the tmux commands.
request ( SetHooksRequest ) – Which hook to set, to what, and how. (for SetAsync(request, cancellationToken) [overload 2])

Returns

The hook as tmux holds it afterwards.

Raises

TmuxOptionException – tmux rejected the hook or its command. (for SetAsync(request, cancellationToken) [overload 1])
TmuxOptionException – tmux rejected the hook or a command. (for SetAsync(request, cancellationToken) [overload 2])

Discussed in Options and hooks