Message references¶
Managers¶
-
class
whalesong.managers.message.
MessageCollectionManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseCollectionManager
Message collection manager.
Parameters: - driver (
BaseWhalesongDriver
) – Whalesong driver - manager_path (
str
) – Manager prefix path.
-
__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
- name (
-
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_item_by_id
(item_id)¶ Get model by identifier.
Parameters: item_id ( str
) – Model identifier.Return type: Result
[+MODEL_TYPE]Returns: Model object.
-
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_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
) – MediaMixinReturn type: BytesIO
Returns: Media stream.
- driver (
-
class
whalesong.managers.message.
MessageManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseModelManager
Message object manager.
-
info
¶ -
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
- 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
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.
-
-
class
whalesong.managers.message.
MessageInfoManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseModelManager
Message information object manager.
-
delivery
¶ -
Message delivery acknowledgement collection manager.
-
read
¶ -
Message read acknowledgement collection manager.
-
played
¶ -
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
- 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
MessageInfo
-
-
class
whalesong.managers.message.
MessageAckCollectionManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseCollectionManager
Message acknowledgement collection manager.
Parameters: - driver (
BaseWhalesongDriver
) – Whalesong driver - manager_path (
str
) – Manager prefix path.
-
__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
- name (
-
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_item_by_id
(item_id)¶ Get model by identifier.
Parameters: item_id ( str
) – Model identifier.Return type: Result
[+MODEL_TYPE]Returns: Model object.
-
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_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
- driver (
-
class
whalesong.managers.message.
MessageAckManager
(driver, manager_path='')¶ Bases:
whalesong.managers.BaseModelManager
Message acknowledgement object manager.
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
MessageAck
- driver (
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.
-
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
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
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
-
Model
whalesong.managers.message.
QuotedMessageMixin
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
-
property
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
-
Model
whalesong.managers.message.
LinkContentMixin
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
-
property
thumbnail
: None¶ Page thumbnail.
-
property
-
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
)
StringIdField field
-
property
-
Model
whalesong.managers.message.
MediaFrameMixin
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
-
property
body
: None¶ Base64Field field
-
property
-
Model
whalesong.managers.message.
AuthorMixin
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
StringIdField field
-
Model
whalesong.managers.message.
MediaStreamMixin
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
thumbnail
: None¶ Base64Field field
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
body
: None¶ Base64Field field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
body
: None¶ Base64Field field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
Model
whalesong.managers.message.
PTTMessage
(data=None, *args, **kwargs)¶ Bases:
whalesong.managers.message.AudioMessage
Push to talk message.
-
property
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
isUserCreatedType
:bool
¶ Default value: False BooleanField field
Aliases: - is_user_created_type
-
property
vcardList
: List ofVCardItem
¶ Array of ModelField field (
whalesong.managers.message.VCardItem
)Aliases: - vcard_list
-
property
-
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
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
isUserCreatedType
:bool
¶ Default value: False BooleanField field
Aliases: - is_user_created_type
TimedeltaField field
Aliases: - share_duration
-
property
finalThumbnail
: None¶ Base64Field field
Aliases: - final_thumbnail
-
property
-
Model
whalesong.managers.message.
PaymentMessage
(data=None, *args, **kwargs)¶ Bases:
whalesong.managers.message.BaseMessage
Payment message.
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
Model
whalesong.managers.message.
GroupNotificationMessage
(data=None, *args, **kwargs)¶ Bases:
whalesong.managers.message.BaseMessage
Notification message.
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
Model
whalesong.managers.message.
StickerMessage
(data=None, *args, **kwargs)¶ Bases:
whalesong.managers.message.ImageMessage
Sticker message.
-
property
quotedMsgObj
:BaseMessage
¶ ModelField field (
whalesong.managers.message.BaseMessage
)Aliases: - quoted_msg_obj
-
property
type
:MessageTypes
[READ ONLY]¶ EnumField field [READ ONLY] (
whalesong.managers.message.MessageTypes
)
StringIdField field
-
property
body
: None¶ Base64Field field
StringIdField field
-
property
senderObj
:Contact
¶ ModelField field (
whalesong.managers.contact.Contact
)Aliases: - sender_obj
-
property
ack
:Ack
¶ EnumField field (
whalesong.managers.message.Ack
)
-
property
chat
:Chat
¶ ModelField field (
whalesong.managers.chat.Chat
)
-
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
-
Model
whalesong.managers.message.
MessageInfo
(data=None, flat=False, *args, **kwargs)¶ Bases:
whalesong.models.BaseModel
Message information.
-
property
delivery
: List ofMessageAck
¶ Delivery message acknowledgement list.
-
property
played
: List ofMessageAck
¶ Played message acknowledgement list.
-
property
read
: List ofMessageAck
¶ Read message acknowledgement list.
-
property
-
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: - driver (
BaseWhalesongDriver
) – - model (
MediaMixin
) – MediaMixin
Return type: BytesIO
Returns: Media stream.
- driver (