60 lines
1.4 KiB
Python
60 lines
1.4 KiB
Python
"""Provide the InboxToggleableMixin class."""
|
|
|
|
from ....const import API_PATH
|
|
|
|
|
|
class InboxToggleableMixin:
|
|
"""Interface for classes that can optionally receive inbox replies."""
|
|
|
|
def disable_inbox_replies(self):
|
|
"""Disable inbox replies for the item.
|
|
|
|
.. note::
|
|
|
|
This can only apply to items created by the authenticated user.
|
|
|
|
Example usage:
|
|
|
|
.. code-block:: python
|
|
|
|
comment = reddit.comment("dkk4qjd")
|
|
comment.disable_inbox_replies()
|
|
|
|
submission = reddit.submission("8dmv8z")
|
|
submission.disable_inbox_replies()
|
|
|
|
.. seealso::
|
|
|
|
:meth:`.enable_inbox_replies`
|
|
|
|
"""
|
|
self._reddit.post(
|
|
API_PATH["sendreplies"], data={"id": self.fullname, "state": False}
|
|
)
|
|
|
|
def enable_inbox_replies(self):
|
|
"""Enable inbox replies for the item.
|
|
|
|
.. note::
|
|
|
|
This can only apply to items created by the authenticated user.
|
|
|
|
Example usage:
|
|
|
|
.. code-block:: python
|
|
|
|
comment = reddit.comment("dkk4qjd")
|
|
comment.enable_inbox_replies()
|
|
|
|
submission = reddit.submission("8dmv8z")
|
|
submission.enable_inbox_replies()
|
|
|
|
.. seealso::
|
|
|
|
:meth:`.disable_inbox_replies`
|
|
|
|
"""
|
|
self._reddit.post(
|
|
API_PATH["sendreplies"], data={"id": self.fullname, "state": True}
|
|
)
|