.. include:: strings.rst
Groups
======

.. module:: groups

.. function:: timeline(server_url, group, *args, **kwargs)

  Shows a group’s timeline. Similar to other timeline resources.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-timeline-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: list
  :return: a list of :ref:`status dicts <status_dict>`

.. function:: join(server_url, group, *args, **kwargs)

  Join a group.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post--api-statusnet-groups-join-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: dict
  :return: :ref:`group_dict`

.. function:: leave(server_url, group, *args, **kwargs)

  Leave a group.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post--api-statusnet-groups-leave-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: dict
  :return: :ref:`group_dict`

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

  Create a new group.

  |post|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post--api-statusnet-groups-create.json

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

.. function:: show(server_url, group, *args, **kwargs)

  Returns details about the group.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-show-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: dict
  :return: :ref:`group_dict`

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

  List local groups.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-list_all.json

  :param str server_url: |server_url|
  :rtype: list
  :return: a list of :ref:`group dicts <group_dict>`

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

  Show the groups a given user is a member of.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-list.json

  :param str server_url: |server_url|
  :rtype: list
  :return: a list of :ref:`group dicts <group_dict>`

.. function:: members(server_url, group, *args, **kwargs)

  List the members of a given group.

  |get|

  https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-membership-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: list
  :return: a list of :ref:`user dicts <user_dict>`

.. function:: is_member(server_url, group, *args, **kwargs)

  Show is the specified user is a member of the group.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-is_member.json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: dict
  :return: dict with ``is_member`` key set to ``True`` if the user is a member
     of the group, ``False`` otherwise


.. function:: admins(server_url, group, *args, **kwargs)

  List the admins of a given group.

  |get|

  Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get--api-statusnet-groups-admins-(int-id)(string-nickname).json

  :param str server_url: |server_url|
  :param group: |group|
  :rtype: list
  :return: a list of :ref:`user dicts <user_dict>`