Flow Module Reference
New in version 0.1.0.
Control Flow using JXA-like syntax.
Classes:
|
A class for managing and interacting with Flow.app. |
- class PyXA.apps.Flow.XAFlowApplication(properties)[source]
Bases:
XASBApplicationA class for managing and interacting with Flow.app.
New in version 0.1.0.
Methods:
Gets the current phase (e.g. Flow or Break).
get_time()Gets the remaining time of the current session.
hide()Hides the Flow app window.
previous()Reloads the current or previous session.
reset()Resets the session progress.
show()Shows the Flow app window.
skip()Skips the current session.
start()Starts or resumes the current session.
stop()Stops the current session.
- get_phase() str[source]
Gets the current phase (e.g. Flow or Break)
- Returns:
The name of the current session
- Return type:
str
New in version 0.1.0.
- get_time() timedelta[source]
Gets the remaining time of the current session.
- Returns:
The remaining time of the current session
- Return type:
timedelta
New in version 0.1.0.
- hide() str[source]
Hides the Flow app window.
- Returns:
The name of the current session
- Return type:
str
New in version 0.1.0.
- previous() str[source]
Reloads the current or previous session.
- Returns:
The name of the next pending session
- Return type:
str
New in version 0.1.0.
- reset() str[source]
Resets the session progress.
- Returns:
The name of the next pending session
- Return type:
str
New in version 0.1.0.
- show() str[source]
Shows the Flow app window.
- Returns:
The name of the current session
- Return type:
str
New in version 0.1.0.
- skip() str[source]
Skips the current session.
- Returns:
The name of the next pending session.
- Return type:
str
New in version 0.1.0.