.. include:: strings.rst
ActivityStreams
================

.. module:: activity_streams

.. function:: public(server_url, *args, **kwargs)

  Returns the most recent notices, including repeats if they exist, from
  non-protected users.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-public_timeline.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`

.. function:: home(server_url, *args, **kwargs)

  Returns the most recent notices, including repeats if they exist,
  posted by the authenticating user and the users they follow.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-home_timeline.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`

.. function:: friends(server_url, *args, **kwargs)

  Home timeline for the specified user.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-friends_timeline.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`

.. function:: user(server_url, *args, **kwargs)

  Returns the most recent notices posted by the authenticating user. It
  is also possible to request another user's timeline by using the
  ``screen_name`` or ``user_id`` parameter. The other users timeline will only
  be visible if they are not protected, or if the authenticating user's follow
  request was accepted by the protected user.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-user_timeline.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`

.. function:: mentions(server_url, *args, **kwargs)

  Returns the most recent mentions (notices containing @username) for
  the authenticating user or specified user.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-mentions.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`

.. function:: replies(server_url, *args, **kwargs)

  Returns the most recent mentions (notices containing @username) for
  the authenticating user or specified user.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/activity_streams.html#get--api-statuses-replies.as

  :param str server_url: |server_url|
  :rtype: dict
  :return: :ref:`as_dict`