|
Stellt alle Funktionen der REST-API die mit yigg.groups.* beginnen zur Verfuegung.
|
Functions
|
|
get_groupname_by_id
get_storys_by_group
get_storys_by_group_pages
list_groups
list_groups_pages
|
|
|
get_groupname_by_id
|
get_groupname_by_id ( id, api_key )
Gibt den Gruppennamen zurueck, der zu einer bestimmten ID assoziiert ist
Aufruf: get_groupname_by_id(id, api_key)
Rueckgabe: string
|
|
|
get_storys_by_group
|
get_storys_by_group (
group_id,
api_key,
page=None,
)
Erzeugt eine Liste mit den Nachrichten einer Gruppe.
Da YiGG die Nachrichten auf mehrere Seiten aufteilt gibt es den optionalen
Parameter page.
Per default wird die erste Seite angezeigt, mit page="ALL" kann jedoch alles angezeigt werden. (Derzeit nicht implementiert).
|
|
|
get_storys_by_group_pages
|
get_storys_by_group_pages ( group_id, api_key )
Hiermit erhaelt man die Anzahl an Seiten die es gibt wenn man die Stories die in einer Gruppe veroeffentlicht sind abfragt.
Aufruf: get_storys_by_group_pages(group_id, api_key)
Rueckgabe: int
|
|
|
list_groups
|
list_groups ( api_key, page=None )
Gibt eine Liste mit Gruppen zurueck.
Da YiGG diese Liste aufsplittet, gibt es den optionalen Parameter page.
Dieser ermoeglicht es, nur eine bestimmte Seite anzuzeigen. Mit page="ALL" kann mann alle Gruppen bekommen. Defualt ist, dass man nur die erste Seite bekommt.
Achtung: Die Liste mit allen Gruppen kann sehr lange sein (derzeit rund 100 Eintraege).
Aufruf: list_groups(api_key, page=None)
Rueckgabe: [struktur.Group(), struktur.Group(), ...]
|
|
|
list_groups_pages
|
list_groups_pages ( api_key, page=1 )
|
|