Skip to content

whatsapie/ext/message/media.py

Media

Bases: Message

Inherits from Message class.

Inherits from Message class, represents a Media Message api object.

Parameters:

Name Type Description Default
type str

Media type, Supports 'image', 'audio', 'document', 'video'

 None
link str

Link to the hosted media on the web.

 None
caption str

Media caption.

 None
filename str

Media filename.

 None
Source code in whatsapie/ext/message/media.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class Media(Message):
    """Inherits from Message class.

    Inherits from Message class, represents a Media Message api object.

    Args:
        type: Media type, Supports 'image', 'audio', 'document', 'video'
        link: Link to the hosted media on the web.
        caption: Media caption.
        filename: Media filename.
    """

    def __init__(
        self,
        type: str = None,
        link: str = None,
        caption: str = None,
        filename: str = None,
        to: str = None,
    ):

        self.set_params(type=type, link=link, caption=caption, filename=filename)
        super().__init__(to=to)

    def set_params(
        self, type: str, link: str, caption: str = None, filename: str = None
    ):
        """Sets the required instance parameters.

        Args:
            type: Media type, Supports 'image', 'audio', 'document', 'video'
            link: Link to the hosted media on the web.
            caption: Media caption.
            filename: Media filename.
        """
        self.type = type
        self.link = link
        self.caption = None
        self.filename = None

        if type in CAPTION_ALLOWED_MEDIA_TYPES:
            self.caption = caption

        if type in FILENAME_ALLOWED_MEDIA_TYPES:
            self.filename = filename

set_params(type, link, caption=None, filename=None)

Sets the required instance parameters.

Parameters:

Name Type Description Default
type str

Media type, Supports 'image', 'audio', 'document', 'video'

 required
link str

Link to the hosted media on the web.

 required
caption str

Media caption.

 None
filename str

Media filename.

 None
Source code in whatsapie/ext/message/media.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def set_params(
    self, type: str, link: str, caption: str = None, filename: str = None
):
    """Sets the required instance parameters.

    Args:
        type: Media type, Supports 'image', 'audio', 'document', 'video'
        link: Link to the hosted media on the web.
        caption: Media caption.
        filename: Media filename.
    """
    self.type = type
    self.link = link
    self.caption = None
    self.filename = None

    if type in CAPTION_ALLOWED_MEDIA_TYPES:
        self.caption = caption

    if type in FILENAME_ALLOWED_MEDIA_TYPES:
        self.filename = filename