Connection references

Managers

class whalesong.managers.conn.ConnManager(driver, manager_path='')

Bases: whalesong.managers.BaseModelManager

Parameters:
__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
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_model()

Get model object

Return type:Result[+MODEL_TYPE]
Returns:Model object
get_model_result_class()
Return type:Result[+MODEL_TYPE]
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 Conn

update_pushname(name)

Update user’s push name.

Parameters:name (str) – New push name
Return type:Result[None]
can_update_pushname()

Whether it is possible to update push name or not.

Return type:Result[bool]
Returns:Whether it is possible to update push name or not.

Models

Model whalesong.managers.conn.PhoneDescription(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property mcc: str

¿?

property mnc: str

¿?

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property whatsappVersion: str

StringIdField field

Aliases:
  • whatsapp_version
  • wa_version
property osVersion: str

StringIdField field

Aliases:
  • os_version
property deviceManufacturer: str

StringIdField field

Aliases:
  • device_manufacturer
property deviceModel: str

StringIdField field

Aliases:
  • device_model
property osBuildNumber: str

StringIdField field

Aliases:
  • os_build_number
Model whalesong.managers.conn.Conn(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property ref: str

Client token reference. Used on QR.

property refTTL: int

Ref time to live

property connected: bool

Whether is connected or not.

property me: str

Whatsapp user identifier.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property whatsappId: str

StringIdField field

Aliases:
  • whatsapp_id
  • wid
property protoVersion: List of int

Array of IntegerField field

Aliases:
  • proto_version
property clientToken: str

StringIdField field

Aliases:
  • client_token
property serverToken: str

StringIdField field

Aliases:
  • server_token
property isResponse: bool

BooleanField field

Aliases:
  • is_response
property smbTos: int

IntegerField field

Aliases:
  • smb_tos
property battery: int

Phone battery level, in percentage.

property plugged: bool

Whether phone is plugged to charger or not.

property locale: str

Phone locale.

Aliases:
  • lc
property language: str

Phone language.

Aliases:
  • lg
property locales: str

Phone locale-language.

property is_24h: bool

Whether time must be in 24h format.

Aliases:
  • is24h
property platform: str

Platform (android, iphone, wp7, etc…)

property phone: PhoneDescription

Phone description.

property tos: int

¿?

property pushname: str

Current user’s push name.