Python API

method libtmux latest

Window.refresh

Refresh window attributes from tmux.

Source and package

Qualified name: libtmux.Window.refresh
Module: libtmux
Declared in: Window
Package: libtmux
Source: src/libtmux/window.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure

refresh (self) → None method [source] ¶

Description#

Scoped to this window's own session (list-windows -t @ID), so tmux -- not libtmux -- decides which session the window belongs to. See Window.from_window_id().

>>> window.refresh()
>>> window.window_id
'@1'

Raises

ValueError – When window_id is unset. Surfaces a clear error under python -O, where an assert would be stripped.
TmuxObjectDoesNotExist – When the window no longer exists.
LibTmuxException – When tmux itself is unreachable.

The tmux commands behind refresh.

The C declarations in tmux that implement these commands.

Read a window again

Equivalents of Read a window again in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`window.Window.refreshed`
Rust	`window.Window.refresh`
Go	`tmux.Window.Refresh`
Java	`io.github.libtmux.Window.refresh`
C#	`LibTmux.Window.RefreshAsync`
C++	`libtmux::Window::refresh`
Swift	reads are snapshots; `Server.snapshot()` takes a new one rather than refreshing a handle
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	Acquire a new snapshot; retained captured entities never refresh in place.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.