Message references

Managers

class whalesong.managers.message.MessageCollectionManager(driver, manager_path='')

Bases: whalesong.managers.BaseCollectionManager

Message collection manager.

Parameters:
__getitem__(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
__getattr__(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
add_submanager(name, submanager)

Add a submanager.

Parameters:
  • name (str) – Field where manager will be stored.
  • submanager (BaseManager) – Submanager
find_item_by_id(item_id)

Find model by identifier. If item is not in collection it will try to load it.

Parameters:item_id (str) – Model identifier.
Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_commands()

Get manager available static commands.

Return type:Result[List[str]]
Returns:Manager static commands.
get_first()

Get first item in collection.

Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_item_by_id(item_id)

Get model by identifier.

Parameters:item_id (str) – Model identifier.
Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_item_result_class()
Return type:Result[+MODEL_TYPE]
get_items()

Get all items on collection.

Return type:IteratorResult[+MODEL_TYPE]
Returns:Async iterator
get_iterator_result_class()
Return type:IteratorResult[+MODEL_TYPE]
get_last()

Get last item in collection.

Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_length()

Get collection items count.

Return type:Result[int]
Returns:Items count
get_monitor_result_class()
Return type:MonitorResult[+MODEL_TYPE]
get_submanager(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
monitor_add()

Monitor add item collection. Iterate each time a item is added to collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
monitor_change()

Monitor change item collection. Iterate each time a item change in collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
monitor_field(field)

Monitor item’s field change. Iterate each time a field changed in any item of collection.

Return type:MonitorResult[Dict[str, Any]]
Returns:Model object iterator
monitor_remove()

Monitor remove item collection. Iterate each time a item is removed from collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
remove_item_by_id(item_id)

Remove item by identifier.

Parameters:item_id (str) – Model identifier.
Return type:Result[None]
remove_submanager(name)

Remove a submanager.

Parameters:name (str) – Field where submanager was stored.
Return type:Result[~T]
MODEL_MANAGER_CLASS

alias of MessageManager

monitor_new()

Monitor new messages.

Return type:MonitorResult[BaseMessage]
Returns:New message monitor.
await download_media(model)

Download message’s attached media file. It will decrypt media file using key on message object.

Parameters:model (MediaMixin) – MediaMixin
Return type:BytesIO
Returns:Media stream.
class whalesong.managers.message.MessageManager(driver, manager_path='')

Bases: whalesong.managers.BaseModelManager

Message object manager.

info

MessageInfoManager

Message information manager.

__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 BaseMessage

await download_media()

Download message’s attached media file. It will decrypt media file using key on message object.

Return type:BytesIO
Returns:Media stream.
fetch_info()

Fetch message information. It must fetch before try to use message information manager.

Return type:Result[MessageInfo]
Returns:Message information (MessageInfo)
can_star()

Check whether message could be starred.

Return type:Result[bool]
Returns:Whether message could be starred.
star()

Star message.

Return type:Result[bool]
unstar()

Unstar message.

Return type:Result[bool]
can_revoke()

Check whether message could be revoked (deleted for other).

Return type:Result[bool]
Returns:Whether message could be revoked.
revoke(clear_media=True)

Revoke message.

Return type:Result[str]
class whalesong.managers.message.MessageInfoManager(driver, manager_path='')

Bases: whalesong.managers.BaseModelManager

Message information object manager.

delivery

MessageAckCollectionManager

Message delivery acknowledgement collection manager.

read

MessageAckCollectionManager

Message read acknowledgement collection manager.

played

MessageAckCollectionManager

Message played acknowledgement collection manager.

__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 MessageInfo

class whalesong.managers.message.MessageAckCollectionManager(driver, manager_path='')

Bases: whalesong.managers.BaseCollectionManager

Message acknowledgement collection manager.

Parameters:
__getitem__(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
__getattr__(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
add_submanager(name, submanager)

Add a submanager.

Parameters:
  • name (str) – Field where manager will be stored.
  • submanager (BaseManager) – Submanager
find_item_by_id(item_id)

Find model by identifier. If item is not in collection it will try to load it.

Parameters:item_id (str) – Model identifier.
Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_commands()

Get manager available static commands.

Return type:Result[List[str]]
Returns:Manager static commands.
get_first()

Get first item in collection.

Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_item_by_id(item_id)

Get model by identifier.

Parameters:item_id (str) – Model identifier.
Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_item_result_class()
Return type:Result[+MODEL_TYPE]
get_items()

Get all items on collection.

Return type:IteratorResult[+MODEL_TYPE]
Returns:Async iterator
get_iterator_result_class()
Return type:IteratorResult[+MODEL_TYPE]
get_last()

Get last item in collection.

Return type:Result[+MODEL_TYPE]
Returns:Model object.
get_length()

Get collection items count.

Return type:Result[int]
Returns:Items count
get_monitor_result_class()
Return type:MonitorResult[+MODEL_TYPE]
get_submanager(name)

Get a submanager. It could be a explicit submanager or contained model manager.

Parameters:name (str) – Field where submanager was stored.
Return type:Union[BaseManager, ~MODEL_MANAGER_TYPE]
monitor_add()

Monitor add item collection. Iterate each time a item is added to collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
monitor_change()

Monitor change item collection. Iterate each time a item change in collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
monitor_field(field)

Monitor item’s field change. Iterate each time a field changed in any item of collection.

Return type:MonitorResult[Dict[str, Any]]
Returns:Model object iterator
monitor_remove()

Monitor remove item collection. Iterate each time a item is removed from collection.

Return type:MonitorResult[+MODEL_TYPE]
Returns:Model object iterator
remove_item_by_id(item_id)

Remove item by identifier.

Parameters:item_id (str) – Model identifier.
Return type:Result[None]
remove_submanager(name)

Remove a submanager.

Parameters:name (str) – Field where submanager was stored.
Return type:Result[~T]
MODEL_MANAGER_CLASS

alias of MessageAckManager

class whalesong.managers.message.MessageAckManager(driver, manager_path='')

Bases: whalesong.managers.BaseModelManager

Message acknowledgement object manager.

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 MessageAck

Models

class whalesong.managers.message.MessageTypes

Bases: enum.Enum

An enumeration.

NOTIFICATION_TEMPLATE = 'notification_template'
GROUP_NOTIFICATION = 'group_notification'
GP2 = 'gp2'
BROADCAST_NOTIFICATION = 'broadcast_notification'
E2E_NOTIFICATION = 'e2e_notification'
CALL_LOG = 'call_log'
PROTOCOL = 'protocol'
CIPHERTEXT = 'ciphertext'
REVOKED = 'revoked'
UNKNOWN = 'unknown'
CHAT = 'chat'
IMAGE = 'image'
VCARD = 'vcard'
MULTI_VCARD = 'multi_vcard'
LOCATION = 'location'
PAYMENT = 'payment'
DOCUMENT = 'document'
AUDIO = 'audio'
PTT = 'ptt'
VIDEO = 'video'
STICKER = 'sticker'
class whalesong.managers.message.Ack

Bases: enum.Enum

An enumeration.

ERROR = -1
PENDING = 0
SERVER = 1
DEVICE = 2
READ = 3
PLAYED = 4
Model whalesong.managers.message.VCardItem(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

vCard item.

property vcard: str

Serialized vCard object.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property displayName: str

StringIdField field

Aliases:
  • display_name
class whalesong.managers.message.MessageMetaclass(name, bases, classdict)

Bases: dirty_models.models.CamelCaseMeta

Message metaclass. It will build message model according to type.

Model whalesong.managers.message.BaseMessage(data=None, *args, **kwargs)

Bases: whalesong.models.BaseModel

Base message model.

property type: MessageTypes [READ ONLY]

Message type.

property subtype: str

Message subtype.

property body: str

Message content.

property timestamp: datetime

Message timestamp.

Aliases:
  • t
property to: str

¿?

property author: str

¿?

property sender: str

Sender’s contact identifier.

property self: str
Default value:in

¿?

property ack: Ack

Acknowledge state.

property invis: bool
Default value:False

¿?

property star: bool
Default value:False

Whether it is starred or not.

List of links of message.

property chat: Chat

Chat object where message was sent.

property dir: str

¿?

property rtl: bool
Default value:False

Whether message’s content is a right to left text.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded
property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.QuotedMessageMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
Model whalesong.managers.message.MentionsMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
Model whalesong.managers.message.LinkContentMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property description: str

Page description.

property title: str

Page title.

property thumbnail: None

Page thumbnail.

List of links. ¿?

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property matchedText: str

StringIdField field

Aliases:
  • matched_text
property canonicalUrl: str

StringIdField field

Aliases:
  • canonical_url
property linkPreview: bool
Default value:False

BooleanField field

Aliases:
  • link_preview
Model whalesong.managers.message.MediaMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
Model whalesong.managers.message.MediaFrameMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property body: None

Base64Field field

property height: int

IntegerField field

property width: int

IntegerField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

Model whalesong.managers.message.AuthorMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property author: str

StringIdField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

Model whalesong.managers.message.MediaStreamMixin(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

property streamable: bool
Default value:False

BooleanField field

property durantion: int

IntegerField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property isGif: bool
Default value:False

BooleanField field

Aliases:
  • is_gif
property gifAttribution: bool
Default value:False

BooleanField field

Aliases:
  • gif_attribution
Model whalesong.managers.message.TextMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.LinkContentMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.BaseMessage

Text message.

property font: str

StringIdField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property matchedText: str

StringIdField field

Aliases:
  • matched_text
property canonicalUrl: str

StringIdField field

Aliases:
  • canonical_url
property description: str

StringIdField field

property title: str

StringIdField field

property thumbnail: None

Base64Field field

property linkPreview: bool
Default value:False

BooleanField field

Aliases:
  • link_preview

Array of StringIdField field

property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded
property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
property textColor: str

StringIdField field

Aliases:
  • text_color
property backgroundColor: str

StringIdField field

Aliases:
  • background_color
Model whalesong.managers.message.ImageMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.MediaMixin, whalesong.managers.message.MediaFrameMixin, whalesong.managers.message.BaseMessage

Image message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property body: None

Base64Field field

property height: int

IntegerField field

property width: int

IntegerField field

property subtype: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.VideoMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.MediaMixin, whalesong.managers.message.MediaFrameMixin, whalesong.managers.message.MediaStreamMixin, whalesong.managers.message.BaseMessage

Video message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property body: None

Base64Field field

property height: int

IntegerField field

property width: int

IntegerField field

property streamable: bool
Default value:False

BooleanField field

property durantion: int

IntegerField field

property isGif: bool
Default value:False

BooleanField field

Aliases:
  • is_gif
property gifAttribution: bool
Default value:False

BooleanField field

Aliases:
  • gif_attribution
property subtype: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.AudioMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.MediaMixin, whalesong.managers.message.MediaStreamMixin, whalesong.managers.message.BaseMessage

Audio message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property streamable: bool
Default value:False

BooleanField field

property durantion: int

IntegerField field

property isGif: bool
Default value:False

BooleanField field

Aliases:
  • is_gif
property gifAttribution: bool
Default value:False

BooleanField field

Aliases:
  • gif_attribution
property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.PTTMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.AudioMessage

Push to talk message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property streamable: bool
Default value:False

BooleanField field

property durantion: int

IntegerField field

property isGif: bool
Default value:False

BooleanField field

Aliases:
  • is_gif
property gifAttribution: bool
Default value:False

BooleanField field

Aliases:
  • gif_attribution
property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.DocumentMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.MediaMixin, whalesong.managers.message.BaseMessage

Document message.

property body: None

Base64Field field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property subtype: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
property pageCount: int

IntegerField field

Aliases:
  • page_count
Model whalesong.managers.message.VCardMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.BaseMessage

vCard message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.MultiVCardMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.BaseMessage

Multi vCard message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
property vcardList: List of VCardItem

Array of ModelField field (whalesong.managers.message.VCardItem)

Aliases:
  • vcard_list
Model whalesong.managers.message.LocationMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.QuotedMessageMixin, whalesong.managers.message.MentionsMixin, whalesong.managers.message.BaseMessage

Location message.

property body: None

Base64Field field

property lat: float

FloatField field

property lng: float

FloatField field

property loc: str

StringIdField field

property accuracy: int

IntegerField field

property speed: int

IntegerField field

property degrees: float

FloatField field

property comment: str

StringIdField field

property sequence: int

IntegerField field

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
property isLive: bool
Default value:False

BooleanField field

Aliases:
  • is_live
property shareDuration: timedelta

TimedeltaField field

Aliases:
  • share_duration
property finalThumbnail: None

Base64Field field

Aliases:
  • final_thumbnail
property finalLat: float

FloatField field

Aliases:
  • final_lat
property finalLng: float

FloatField field

Aliases:
  • final_lng
property finalAccuracy: int

IntegerField field

Aliases:
  • final_accuracy
property finalSpeed: int

IntegerField field

Aliases:
  • final_speed
property finalDegrees: float

FloatField field

Aliases:
  • final_degrees
property finalTimeOffset: timedelta

TimedeltaField field

Aliases:
  • final_time_offset
property duration: timedelta

TimedeltaField field

property text: str

StringIdField field

Model whalesong.managers.message.PaymentMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.BaseMessage

Payment message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.GroupNotificationMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.BaseMessage

Notification message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property subtype: str

StringIdField field

property body: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
property urlText: str

StringIdField field

Aliases:
  • url_text
property urlNumber: int

IntegerField field

Aliases:
  • url_number
property recipients: List of str

Array of StringIdField field

property broadcast: bool
Default value:False

BooleanField field

property multicast: bool
Default value:False

BooleanField field

Model whalesong.managers.message.StickerMessage(data=None, *args, **kwargs)

Bases: whalesong.managers.message.ImageMessage

Sticker message.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property quotedMsgObj: BaseMessage

ModelField field (whalesong.managers.message.BaseMessage)

Aliases:
  • quoted_msg_obj
property quotedStanzaID: str

StringIdField field

Aliases:
  • quoted_stanza_id
property quotedParticipant: str

StringIdField field

Aliases:
  • quoted_participant
property quotedRemoteJid: str

StringIdField field

Aliases:
  • quoted_remote_jid
property mentionedJidList: List of str

Array of StringIdField field

Aliases:
  • mentioned_jid_list
property type: MessageTypes [READ ONLY]

EnumField field [READ ONLY] (whalesong.managers.message.MessageTypes)

property clientUrl: str

StringIdField field

Aliases:
  • client_url
property directPath: str

StringIdField field

Aliases:
  • direct_path
property mimetype: str

StringIdField field

property caption: str

StringIdField field

property filehash: str

StringIdField field

property size: int

IntegerField field

property mediaKey: str

StringIdField field

Aliases:
  • media_key
property isUnsentMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_unsent_media
property body: None

Base64Field field

property height: int

IntegerField field

property width: int

IntegerField field

property subtype: str

StringIdField field

property timestamp: datetime

DateTimeField field

Aliases:
  • t
property notifyName: str

StringIdField field

Aliases:
  • notify_name
property from: str

StringIdField field

Aliases:
  • from
property to: str

StringIdField field

property author: str

StringIdField field

property sender: str

StringIdField field

property senderObj: Contact

ModelField field (whalesong.managers.contact.Contact)

Aliases:
  • sender_obj
property self: str
Default value:in

StringIdField field

property ack: Ack

EnumField field (whalesong.managers.message.Ack)

property invis: bool
Default value:False

BooleanField field

property isNewMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_new_msg
property star: bool
Default value:False

BooleanField field

property isForwarded: bool
Default value:False

BooleanField field

Aliases:
  • is_forwarded

Array of StringIdField field

property chat: Chat

ModelField field (whalesong.managers.chat.Chat)

property isGroupMsg: bool
Default value:False

BooleanField field

Aliases:
  • is_group_msg
property isStatusV3: bool
Default value:False

BooleanField field

Aliases:
  • is_status_v3
property isPSA: bool
Default value:False

BooleanField field

Aliases:
  • is_psa
property statusV3TextBg: str

StringIdField field

Aliases:
  • status_v3_text_bg
property isSentByMe: bool
Default value:False

BooleanField field

Aliases:
  • is_sent_by_me
property isNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_notification
property isGroupNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_group_notification
property isBizNotification: bool
Default value:False

BooleanField field

Aliases:
  • is_biz_notification
property isMedia: bool
Default value:False

BooleanField field

Aliases:
  • is_media
Default value:False

BooleanField field

Aliases:
  • is_link
Default value:False

BooleanField field

Aliases:
  • has_link
property isDoc: bool
Default value:False

BooleanField field

Aliases:
  • is_doc
property isMms: bool
Default value:False

BooleanField field

Aliases:
  • is_mms
property isRevoked: bool
Default value:False

BooleanField field

Aliases:
  • is_revoked
property showForwarded: bool
Default value:False

BooleanField field

Aliases:
  • show_forwarded
property containsEmoji: bool
Default value:False

BooleanField field

Aliases:
  • contains_emoji
property isFailed: bool
Default value:False

BooleanField field

Aliases:
  • is_failed
property dir: str

StringIdField field

property rtl: bool
Default value:False

BooleanField field

property isPersistent: bool
Default value:False

BooleanField field

Aliases:
  • is_persistent
property isUserCreatedType: bool
Default value:False

BooleanField field

Aliases:
  • is_user_created_type
property hasPromises: bool
Default value:False

BooleanField field

Aliases:
  • has_promises
Model whalesong.managers.message.MessageAck(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

Message acknowledgement.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property timestamp: datetime

Ack timestamp.

Aliases:
  • t
Model whalesong.managers.message.MessageInfo(data=None, flat=False, *args, **kwargs)

Bases: whalesong.models.BaseModel

Message information.

property id: str [READ ONLY]

StringIdField field [READ ONLY]

property deliveryRemaining: int
Default value:0

IntegerField field

Aliases:
  • delivery_remaining
property isPtt: bool
Default value:False

BooleanField field

Aliases:
  • is_ptt
property playedRemaining: int
Default value:0

IntegerField field

Aliases:
  • played_remaining
property readRemaining: int
Default value:0

IntegerField field

Aliases:
  • read_remaining
property delivery: List of MessageAck

Delivery message acknowledgement list.

property played: List of MessageAck

Played message acknowledgement list.

property read: List of MessageAck

Read message acknowledgement list.

await whalesong.managers.message.download_media(driver, model)

Download message’s attached media file. It will decrypt media file using key on message object.

Parameters:
Return type:

BytesIO
Returns:

Media stream.