CIB doXiview - Integration

Kommunikation über CIB iwc

Die Result Callback-Struktur

Funktionen aus den Kommunikationsschnittstellen können entweder einen definierten Rückgabewert oder keinen Rückgabewert haben.

Wird eine Funktion aufgerufen, die keinen Rückgabewert definiert, bekommt die aufrufende Anwendung nach dem Aufruf keinerlei Rückmeldung mehr in irgendeiner Form.

Wenn dagegen eine Funktion mit einem Rückgabewert definiert ist, muss der Aufrufer seinerseits zwei Funktionen namens success und failure definieren, welche im Erfolgsfall und im Fehlerfall mit einem jeweils passenden Rückgabewert aufgerufen werden. Diese beiden Funktionen werden zu einem Objekt zusammengefasst übergeben, welches im folgenden Result Callback genannt wird. Das Result Callback lässt sich am einfachsten als JavaScript Objekt-Literal definieren wie folgt:


Der im Fehlerfall an failure übergebene Parameter error ist stets wie folgt aufgebaut:


Die Struktur des im Erfolgsfall an success übergebenen Parameters params hängt jeweils von der aufgerufenen Funktion ab und ist der Dokumentation der Funktion zu entnehmen.

Beispielsweise liefert die Funktion getViewStateInfo der Kommunikationsschnittstelle doXiview im Erfolgsfall laut Dokumentation die folgende Struktur als Parameter params:

{
    currentBundleDocumentID: the current bundle document id,
    currentDocumentID: the current document id,
    currentDocumentPageCount: the page count for the current document,
    currentPageNumber: the current page number
}

Das folgende Code-Beispiel fasst zusammen, wie Sie mit dieser Funktion in Ihrer Master-Anwendung die Nummer der aktuell in CIB doXiview angezeigten Dokumentseite und die Anzahl der Seiten abfragen können:


Die obige Funktion displayPageNumber() könnte z.B. vom Benutzer Ihrer Anwendung durch einen wie folgt definierten Button ausgelöst werden: