Initialisierung der JS-Bibliothek

Instanziierung

connector = new Sociallyve();

Initialisierung

connector.setCallbackFunctionForLogin(callBackForLogin);
connector.setCallbackFunctionForImport(callBackForImport);

Diese Callbackfunktionen werden aufgerufen, nachdem Ihr Backend den Userdatensatz verarbeitet hat (je nach Usecase entweder die callBackForLogin oder die callBackForImport). Die Antwort, die Ihr Backend dabei zurückgegeben hat, wird als Parameter an die Callbackfunktionen weitergereicht.

Sie müssen diese Funktionen zuvor in Ihrem Javascript definieren:

var callBackForLogin = function(response, textStatus, jqXHR){
console.log(response)
}

Eigene JS-Funktionen zur Verarbeitung der Userdatensätze

Wenn benötigt, können eigene Funktionen angegeben werden, welche zur Verarbeitung der Userdatensätze aufgerufen werden sollen:

connector.setLoginFunction(function(paramStr){console.log(paramStr);});

und/oder

connector.setImportFunction(function(paramStr){console.log(paramStr);});

Die JS-Bibliothek übernimmt dann keine weiteren Aufgaben mehr und führt nur diese Funktionen aus. Auch die unter Initialisierung (siehe weiter oben) definierten Callback Funktionen werden nicht genutzt.

Abweichende Callback-URL (z.B. fürs Entwicklungssystem)

Es besteht die Möglichkeit, der JS-Bibliothek eine “beliebige” Callback-URL mitzuteilen. Dafür gibt es in der Projekteinstellung einen Parameter, die “Authorities/Hosts”.

Es wird serverseitig überprüft, ob die Authority (Host/Port) der im konkreten Request übermittelten Callback-URL mit der in den Projekteinstellungen “von rechts” bei allyve übereinstimmt. Somit sind auch verschiedene Subdomains möglich.

Beispiel
Ist beispielsweise die Authority “allyve.de:123″ hinterlegt, so wäre auch die Callback-URL “testsystem.allyve.de:123″ valide. Wäre die Authority “www.allyve.de:123″ hinterlegt, so wäre auch die Callback-URL “testsystem.www.allyve.de:123″ valide.

Sollte diese Regeln nicht zutreffen oder die Projekteinstellung keine validen Domains beinhalten, wird die Standard Callback-URL, die Sie unter https://sms.allyve.com/ in Ihrer Projektkonfiguration eingegeben haben, genutzt.

In den Projekteinstellung können mehrere Authorities/Hosts freigeschaltet werden. Z.B.: product.staging, test.de, localhost:81. Bitte tragen Sie diese Liste unter https://sms.allyve.com/ in Ihre Projektkonfiguration ein

So wird der Parameter anschließend im eigenen JS gesetzt:

connector = new Sociallyve();
connector.setCallbackUrl('http://localhost:81/libraries/sociallyve/html/xd_allyzer.html');
connector.setCallbackFunctionForLogin(callBackForLogin);
connector.setCallbackFunctionForImport(callBackForImport);

Definition einer Callback-Funktion bei Abbruch der Autorisierung

connector.setCallbackFunctionForError(myErrorHandlingFunction);

Wenn ein Nutzer die Autorisierung über einen Provider (z.B. Facebook oder Twitter) abbricht, so kann auf der Seite der Consuming-Party eine definierte Callback-Funktion aufgerufen werden. Die übergebene Callback-Funktion wird im Falle der erfolglosen Autorisierung mit einem Response-Objekt aufgerufen.

Fehler-Code	Beschreibung
401	Benutzer lehnt Autorisierung ab
1401	Benutzer hat die Autorisierung abgebrochen
406	Unbekannter Provider
500	Fehler bei Usecase. Mehr Details in der Errormessage

Beispiel-Implementation bei der Consuming-Party:

Instanziierung der Callback-Funktion

connector.setCallbackFunctionForError(self.handleSociallyveError);

Gewünschter Umgang mit den Fehlern

this.handleSociallyveError = function(data){
        switch(data.errorcode)
        {
        case "401":
          //execute code
          break;
        case "1401":
          //execute code
          break;
        case "406":
          //execute code
          break;
        case "500":
          //execute code
          break;
        default:
        }
    };

Validierung des Nutzer-Profilbildes

connector.setValidateImages(boolean)

Diese Funktion muss auf true gesetzt werden, wenn beim Login des Nutzers überprüft werden soll, ob das Profilbild des Nutzers ein eigenes oder ein Default-Bild (z.B. bei Twitter ein Ei) des Providers ist.

Diese Funktion ist standardmäßig auf false.

Validierung der Kontakt-Profilbilder

connector.setValidateImagesForImport(boolean)

Diese Funktion muss auf true gesetzt werden, wenn beim Kontakt-Import des Nutzers überprüft werden soll, ob das Profilbild jedes Kontaktes ein eigenes oder ein Default-Bild (z.B. bei Twitter ein Ei) des Providers ist.
HINWEIS: Diese Funktion hat je nach Anzahl der Kontakte eine sehr lange Laufzeit.