Display information references¶
Managers¶
-
class
whalesong.managers.display_info.
DisplayInfoManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseModelManager
Manage display information.
Parameters: - driver (
BaseWhalesongDriver
) – Whalesong driver - manager_path (
str
) – Manager prefix path.
-
__getitem__
(name)¶ Get a submanager.
Parameters: name ( str
) – Field where submanager was stored.Return type: BaseManager
-
__getattr__
(name)¶ Get a submanager.
Parameters: name ( str
) – Field where submanager was stored.Return type: BaseManager
-
add_submanager
(name, submanager)¶ Add a submanager.
Parameters: - name (
str
) – Field where manager will be stored. - submanager (
BaseManager
) – Submanager
- name (
-
get_commands
()¶ Get manager available static commands.
Return type: Result
[List
[str
]]Returns: Manager static commands.
-
get_field_monitor_result_class
(field)¶ Return type: MonitorResult
[Dict
[str
,Any
]]
-
get_monitor_result_class
()¶ Return type: MonitorResult
[+MODEL_TYPE]
-
get_submanager
(name)¶ Get a submanager.
Parameters: name ( str
) – Field where submanager was stored.Return type: BaseManager
-
map_model
(data)¶ Return type: +MODEL_TYPE
-
monitor_field
(field)¶ Monitor any change on a model’s field.
Parameters: field ( str
) – Field to monitor.Return type: MonitorResult
[Dict
[str
,Any
]]Returns: Model monitor
-
monitor_model
()¶ Monitor any change on model.
Return type: MonitorResult
[+MODEL_TYPE]Returns: Model monitor
-
remove_submanager
(name)¶ Remove a submanager.
Parameters: name ( str
) – Field where submanager was stored.Return type: Result
[~T]
-
MODEL_CLASS
¶ alias of
DisplayInfo
-
mark_available
()¶ Mark current user as available. It is need to get presence from other users.
Return type: Result
[None
]
Mark current user as unavailable.
Return type: Result
[None
]
-
set_available_permanent
()¶ Set user available permanently. It starts a loop in order to set availability each 30 seconds.
-
unset_available_permanent
()¶ Unset user available permanently. It stops permanent availability loop.
-
is_available_permanent
()¶ Checks whether permanent availability loop is running.
Returns: Permanent availability loop state.
- driver (
Models¶
-
Model
whalesong.managers.display_info.
DisplayInfo
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
Connection stream model.
-
class
StreamInfo
¶ Bases:
enum.Enum
Stream information.
-
OFFLINE
= 'OFFLINE'¶ Offline.
-
OPENING
= 'OPENING'¶ Opening connection.
-
PAIRING
= 'PAIRING'¶ Pairing phone.
-
SYNCING
= 'SYNCING'¶ Synchronizing data.
-
RESUMING
= 'RESUMING'¶ Resuming connection.
-
CONNECTING
= 'CONNECTING'¶ Connecting.
-
NORMAL
= 'NORMAL'¶ Normal.
-
TIMEOUT
= 'TIMEOUT'¶ Connection timeout.
-
-
class
StreamMode
¶ Bases:
enum.Enum
Stream mode.
-
QR
= 'QR'¶ Wait for QR scan.
-
MAIN
= 'MAIN'¶ Main.
-
SYNCING
= 'SYNCING'¶ Synchronizing data.
-
OFFLINE
= 'OFFLINE'¶ Not connected.
-
CONFLICT
= 'CONFLICT'¶ Other browser has opened session.
-
PROXYBLOCK
= 'PROXYBLOCK'¶ Proxy blocks connection.
-
TOS_BLOCK
= 'TOS_BLOCK'¶ ¿?
-
SMB_TOS_BLOCK
= 'SMB_TOS_BLOCK'¶ ¿?
-
DEPRECATED_VERSION
= 'DEPRECATED_VERSION'¶ Using a deprecated version.
-
-
class
DisplayState
¶ Bases:
enum.Enum
Display state.
-
SHOW
= 'SHOW'¶ Display showing.
-
OBSCURE
= 'OBSCURE'¶ Display obscured.
-
HIDE
= 'HIDE'¶ Display hidden.
-
-
property
displayInfo
:StreamInfo
¶ EnumField field (
whalesong.managers.display_info.StreamInfo
)Aliases: - display_info
-
hard_expired
= None¶ ¿?
-
property
info
:StreamInfo
¶ Same than display info?
-
property
obscurity
:DisplayState
¶ Current display state.
-
property
mode
:StreamMode
¶ Stream mode.
-
class