g4t7 [Main][API]

AggreGATOR JavaScript API (up)

AggreGATOR API Logo
Abbildung 1: AggreGATOR API Logo

Table of Contents (up)

• AggreGATOR JavaScript API
• Table of Contents
• Einführung
• Session Management
• Code
• Methoden Überblick
• User Session
• Login
• LoggedIn
• Logout
• Feed Functions
• GetFeeds
• AddFeed
• RemoveFeed
• Status Functions
• SetRead
• SetUnread
• Error Functions
• ErrorNumber
• ErrorMessage

Einführung (up)

Die AggreGATOR API ist eine auf JavaScript und jQuery basierende API zur Kommunikation mit dem AggreGATOR Serversystem. 
Diese unten Methoden ermöglichen es dem Client-System die zugehörigen Aktionen durchzuführen. 
 
Die Kommunikation mit dem Server erfolgt mittels JSONP. 

Session Management (up)

Das Session Management erfolgt über einen API internen Session-String der bei Anfragen an den Server mitgeschickt wird. 
Dies wird intern von der API Implementierung durchgeführt sodass das Clientsystem davon nichts erfährt. 

Code (up)

Die wichtigsten Komponenten der API sind wie folgt: 
 
Clientseitig 
«JavaScript API»  
 
Serverseitig (Source) 
«API Schnittstelle» 
«RSSFeed Crawler»  
 

Methoden Überblick (up)

Die AggreGATOR API besteht aus folgenden Methoden: 
 
User Session (Details) 
aggreGATOR.Login((string)UserName, (string)Password, (callback)Success, (callback)Failure);
aggreGATOR.LoggedIn((callback)Yes, (callback)No);
aggreGATOR.Logout((callback)Success, (callback)Failure);
 
Feed Functions (Details) 
aggreGATOR.GetFeeds((int)Option, (int)Limit, (callback)Success, (callback)Failure);
aggreGATOR.AddFeed((string)RSSFeedURL, (string)RSSFeedName, (callback)Success, (callback)Failure);
aggreGATOR.RemoveFeed((int)RSSFeedID, (callback)Success, (callback)Failure);
 
Status Functions (Details) 
aggreGATOR.SetRead((int[]) FeedItemID, (callback)Success, (callback)Failure);
aggreGATOR.SetUnread((int[]) FeedItemID, (callback)Success, (callback)Failure);
 
Error Handling (Details) 
aggreGATOR.ErrorNumber();
aggreGATOR.ErrorMessage();        
 

User Session (up)

Login (up)

aggreGATOR.Login((string)UserName, (string)Password, (callback)Success, (callback)Failure);
 
User-Login mittels Benutzernamen und Kennwort. 
Bei erfolgreichem Login wird der Callback Success aktiv, sonst der Callback Failure. 
 
Parameter 
Name
Datentyp
Zweck
UserName
(string)
Benutzername des Users
Password
(string)
Passwort des Users
Success
(callback)
Funktionsaufruf bei erfolgreichem Login
Failure
(callback)
Funktionsaufruf bei fehlgeschlagenem Login
Rückgabewert 
Keiner. 
 

LoggedIn (up)

aggreGATOR.LoggedIn((callback)Yes, (callback)No);
 
Überprüft sowohl lokal, als auch in der PHP Session, ob der Benutzer eingeloggt ist. 
Ist der User in der PHP Session eingeloggt, wird rückwirkend auch die lokale Session-Variable gesetzt. 
 
Parameter 
Name
Datentyp
Zweck
Yes
(callback)
Funktionsaufruf, wenn User eingeloggt ist
No
(callback)
Funktionsaufruf, wenn kein User eingeloggt ist
Rückgabewert 
Keiner. 
 

Logout (up)

aggreGATOR.Logout((callback)Success, (callback)Failure);
 
Dient zum Ausloggen des Benutzers, sowohl lokal als auch in der PHP Session. 
Die aktuell aktive Session wird aus der Session-Tabelle der Datenbank entfernt. 
 
Parameter 
Name
Datentyp
Zweck
Success
(callback)
Funktionsaufruf bei erfolgreichem Logout
Failure
(callback)
Funktionsaufruf bei fehlgeschlagenem Logout
Rückgabewert 
Keiner. 
 

Feed Functions (up)

GetFeeds (up)

aggreGATOR.GetFeeds((int)Option, (int)Limit, (callback)Success, (callback)Failure);
 
Abrufen der RSSFeeds und der zugehörigen FeedItems. 
 
Parameter 
Name
Datentyp
Zweck
Option
(int)
Definiert, was und zu welchem Grad abgerufen wird, siehe Tabelle unten
Limit
(int)
Einschränkung der zurückgelieferten Werte auf [n]FeedItems pro RSSFeed
Success
(callback)
Funktionsaufruf bei erfolgreichem Abrufen  
Beinhaltet die implizit übergeben Parameter feeds und feedItems
Failure
(callback)
Funktionsaufruf bei fehlgeschlagenem Abrufen
Optionen 
 
Wert
Name
Wirkung
0
GetAll
Alle FeedItems
1
GetNew
Alle neuen FeedItems seit letztem Request
2
GetAllUnread
Alle ungelesenen FeedItems
3
GetAllRead
Alle gelesenen FeedItems
4
GetAllNewUnread
Alle seit dem letzten Request explizit auf unglesenen gesetzten FeedItems
5
GetAllNewRead
Alle seit dem letzten Request explizit auf gelesen gesetzten FeedItems
Rückgabewert 
Keiner. 
 
Zusatz 
 
Die Parameter feeds und feedItems sind Arrays. 
Die beinhalteden Elemente verfügen über folgende Werte: 
 
Bei feeds: 
Wert
Zweck
feeds[n].RSSFeedID
Eindeutige ID des RSSFeeds
feeds[n].URL
URL des RSSFeeds
feeds[n].Name
Name des RSSFeeds
Bei feedItems: 
Wert
Zweck
feedItems[n].FeedItemID
Eindeutige ID des FeedItems
feedItems[n].PubDate
Veröffentlichungsdatum des Eintrags
feedItems[n].Title
Titel des Eintrags
feedItems[n].Description
Beschreibung des Eintrags (optional*)
feedItems[n].Link
Link zum Eintrag (optional*)
feedItems[n].Author
Autor des Eintrags (optional*)
feedItems[n].Status
Liefer "Read" oder "Unread"
feedItems[n].RSSFeedID
ID des zugehörigen RSSFeeds
(*) wenn nicht gesetzt, dann Wert "null" 
 

AddFeed (up)

aggreGATOR.AddFeed((string)RSSFeedURL, (string)RSSFeedName, (callback)Success, (callback)Failure);
 
Fügt für den momentan angemeldeten Benutzer einen RSSFeed hinzu. 
 
Parameter 
Name
Datentyp
Zweck
RSSFeedURL
(string)
URL des RSSFeeds
RSSFeedName
(string)
Name es RSSFeeds
Success
(callback)
Funktionsaufruf bei erfolgreichem Hinzufügen
Failure
(callback)
Funktionsaufruf bei fehlgeschlagenem Hinzufügen
Rückgabewert 
Keiner. 

RemoveFeed (up)

aggreGATOR.RemoveFeed((int)RSSFeedID, (callback)Success, (callback)Failure);
 
Löst die Verbindung zwischen dem eingeloggten Beutzer und dem RSSFeed. 
 
Parameter 
Name
Datentyp
Zweck
RSSFeedID
(int)
ID des RSSFeeds
Success
(callback)
Funktionsaufruf bei erfolgreichem Löschen
Failure
(callback)
Funktionsaufruf bei fehlgeschlagenem Löschen
Rückgabewert 
Keiner. 
 

Status Functions (up)

SetRead (up)

aggreGATOR.SetRead((int[]) FeedItemID, (callback)Success, (callback)Failure);
 
Setzt die übergeben FeedItems auf gelesen. 
 
Parameter 
Name
Datentyp
Zweck
FeedItemID
(int[])
Kann sowohl eine einzelne FeedItemID als ein Array von FeedItemIDs sein
Success
(callback)
Funktionsaufruf bei erfolgreicher Operation
Failure
(callback)
Funktionsaufruf bei fehlgeschlagener Operation
Rückgabewert 
Keiner. 
 

SetUnread (up)

aggreGATOR.SetUnread((int[]) FeedItemID, (callback)Success, (callback)Failure);
 
Setzt die übergeben FeedItems auf ungelesen. 
 
Parameter 
Name
Datentyp
Zweck
FeedItemID
(int[])
Kann sowohl eine einzelne FeedItemID als ein Array von FeedItemIDs sein
Success
(callback)
Funktionsaufruf bei erfolgreicher Operation
Failure
(callback)
Funktionsaufruf bei fehlgeschlagener Operation
Rückgabewert 
Keiner. 
 

Error Functions (up)

ErrorNumber (up)

aggreGATOR.ErrorNumber();
 
Gibt einen Fehlercode zurück, der sich besonders in Failure Callbacks sehr zur Fehlerbehandlung empfiehlt. 
 
Parameter 
Keine. 
 
Rückgabewert 
Integer-Code des zuletzt aufgetretenen internen Fehlers. 
 

ErrorMessage (up)

aggreGATOR.ErrorMessage();
 
Gibt eine zur Error Number passende Error Message zurück. Besonders geeignet während der Entwicklung zum debugging. 
 
Parameter 
Keine. 
 
Rückgabewert 
String mit zuletzt aufgetretener Error Message. 
 
. 
Letzte Änderung: 29.01.2010, 23:23 | 811 Worte