Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

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

Kotlin API

class libtmux-kotlin latest

Client

Package i.g.l.kotlin io.github.libtmux.kotlin

An attached tmux client and its captured properties.

View as Markdown

Source and package

Module: io.github.libtmux.kotlin
Package: io.github.libtmux:libtmux-kotlin
Source: libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Client.kt

public class Client class [source] ¶: Description#

Holds the Java handle privately, so a member here always wins over a same-named catalog-generated extension in ClientOperations.kt . Companion hosts the generated query field namespace.

Discussed in Coroutines and flows , Getting started

Members15 members#

Parent objects2 members#

session property The session this client was attached to when captured. A pure read of the capture.
server property

Other members13 members#

asJava property The Java client this wraps: the same object, for a Java API that takes one.
attachment property What this client was looking at when captured. A pure read: it issues no command.
Companion module
detach method Detaches this client, leaving whatever it was attached to running.
detachOthers method Detaches every other client, leaving this one attached.
equals method
fetchAttachment method Takes a new capture and returns what this client is looking at now.
hashCode method
name property The client's terminal name, which is how tmux addresses it.
redraw method Asks tmux to redraw this client.
refresh method Takes a new capture and returns this client as it is now.
switchTo method Moves this client to another session.
toString method