Add mode property to event objects (#233)

* Add mode property to event objects

* Modify tests

* Modify readme

* Adjust line length

Author: cryeo

README.rst

@@ -303,7 +303,7 @@ delete\_rich\_menu(self, rich\_menu\_id, timeout=None)
 Deletes a rich menu.
 
 https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu
-        
+
 .. code:: python
 
     line_bot_api.delete_rich_menu(rich_menu_id)
@@ -949,30 +949,36 @@ The following classes are found in the ``linebot.models`` package.
 
 - MessageEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
     - message: `Message <#message>`__
 - FollowEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
 - UnfollowEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
 - JoinEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
 - LeaveEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
 - PostbackEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
@@ -981,6 +987,7 @@ The following classes are found in the ``linebot.models`` package.
         - params: dict
 - BeaconEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
@@ -990,24 +997,28 @@ The following classes are found in the ``linebot.models`` package.
         - device_message
 - MemberJoinedEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
     - joined: Joined
 - MemberLeftEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
     - left: Left
 - AccountLinkEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
     - link: Link
 - ThingsEvent
     - type
+    - mode
     - timestamp
     - source: `Source <#source>`__
     - reply\_token
@@ -1109,7 +1120,7 @@ Community Q&A: https://www.line-community.me/questions
 
 News: https://developers.line.biz/en/news/
 
-Twitter: @LINE_DEV 
+Twitter: @LINE_DEV
 
 Versioning
 ----------

linebot/models/events.py

@@ -45,9 +45,10 @@ class Event(with_metaclass(ABCMeta, Base)):
     https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects
     """
 
-    def __init__(self, timestamp=None, source=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -56,6 +57,7 @@ def __init__(self, timestamp=None, source=None, **kwargs):
         super(Event, self).__init__(**kwargs)
 
         self.type = None
+        self.mode = mode
         self.timestamp = timestamp
         self.source = self.get_or_new_from_json_dict_with_types(
             source, {
@@ -76,9 +78,11 @@ class MessageEvent(Event):
     You can reply to message events.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, message=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, message=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -88,7 +92,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, message=None,
         :param kwargs:
         """
         super(MessageEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'message'
@@ -115,17 +119,18 @@ class FollowEvent(Event):
     You can reply to follow events.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
         :param str reply_token: Reply token
         :param kwargs:
         """
         super(FollowEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'follow'
@@ -140,16 +145,17 @@ class UnfollowEvent(Event):
     Event object for when your account is blocked.
     """
 
-    def __init__(self, timestamp=None, source=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
         :param kwargs:
         """
         super(UnfollowEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'unfollow'
@@ -164,17 +170,18 @@ class JoinEvent(Event):
     You can reply to join events.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
         :param str reply_token: Reply token
         :param kwargs:
         """
         super(JoinEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'join'
@@ -189,16 +196,17 @@ class LeaveEvent(Event):
     Event object for when your account leaves a group.
     """
 
-    def __init__(self, timestamp=None, source=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
         :param kwargs:
         """
         super(LeaveEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'leave'
@@ -214,9 +222,11 @@ class PostbackEvent(Event):
     You can reply to postback events.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, postback=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, postback=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -226,7 +236,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, postback=None,
         :param kwargs:
         """
         super(PostbackEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'postback'
@@ -244,10 +254,11 @@ class BeaconEvent(Event):
     Event object for when a user detects a LINE Beacon. You can reply to beacon events.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None,
-                 beacon=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, beacon=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -257,7 +268,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None,
         :param kwargs:
         """
         super(BeaconEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'beacon'
@@ -276,10 +287,11 @@ class MemberJoinedEvent(Event):
 
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None,
-                 joined=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, joined=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -289,7 +301,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None,
         :param kwargs:
         """
         super(MemberJoinedEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'memberJoined'
@@ -308,10 +320,10 @@ class MemberLeftEvent(Event):
 
     """
 
-    def __init__(self, timestamp=None, source=None,
-                 left=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, left=None, **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -320,7 +332,7 @@ def __init__(self, timestamp=None, source=None,
         :param kwargs:
         """
         super(MemberLeftEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'memberLeft'
@@ -340,9 +352,11 @@ class AccountLinkEvent(Event):
     no webhook event will be sent and the user will be shown an error.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, link=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, link=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
         :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
@@ -352,7 +366,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, link=None, **k
         :param kwargs:
         """
         super(AccountLinkEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'accountLink'
@@ -372,9 +386,12 @@ class ThingsEvent(Event):
     Event sent from LINE Things Webhook service.
     """
 
-    def __init__(self, timestamp=None, source=None, reply_token=None, things=None, **kwargs):
+    def __init__(self, mode=None, timestamp=None, source=None, reply_token=None, things=None,
+                 **kwargs):
         """__init__ method.
 
+        :param str mode: Channel state
+        :param long timestamp: Time of the event in milliseconds
         :param source: Source object
         :type source: T <= :py:class:`linebot.models.sources.Source`
         :param str reply_token: Reply token
@@ -383,7 +400,7 @@ def __init__(self, timestamp=None, source=None, reply_token=None, things=None, *
         :param kwargs:
         """
         super(ThingsEvent, self).__init__(
-            timestamp=timestamp, source=source, **kwargs
+            mode=mode, timestamp=timestamp, source=source, **kwargs
         )
 
         self.type = 'things'