CIB doXiview - Integration

Die Kommunikationsschnittstellen

Das common Interface

Allgemein
 getStartParameters
 terminate
 fireDataDirty
 lock, unlock
 logout
 resize
 showMessage

Allgemein

Das Kommunikations-Interface common definiert generelle Funktionen, welche nicht CIB doXiview-spezifisch sind, sondern auch in anderen per CIB iwc integrierbaren Anwendungen zum Einsatz kommen können.

Es ist aus Sicht des Masters in Form des Objekts CibCommonMasterFunctions verfügbar.

Dieses wird wie folgt erzeugt:



getStartParameters

Diese Funktion wurde bereits als Beispiel erläutert. Mittels dieser Funktion erfragt CIB doXiview von seinem Integrator die zu verwenden Startparameter.

Function

Parameters

Return

 
getStartParameters

 
callback: ResultCallback

 
JSON

Returns CIB doXiview start parameters required for viewing a document in CIB doXiview. The result will be returned through the success-method of the specified result callback.

Return:

A JSON representation of start parameters which has the following structure:

var startParameters = {
          context : {login context},
          webview : {
               // doXiview specific start parameters
          },
          webedit : {
              // webEdit specific start parameters
          }
  }

Registration by Master:

master.common.registerStartParameterCallback(callback: FunctionCallback);

 

Beispiel-Implementierung aus Sicht Master (integrierende Anwendung):

master.common.registerStartParameterCallback(function() {
        var startParameters = {
               "webview": {
                       "uistyle":"cib",
                       "ui":"upload",
               }
        };
        return startParameters;
});


Hinweis: In der CIB doXiview Testoberfläche können verschiedene voreingestellte Startparameter-Belegungen aus einer Liste ausgewählt werden.

Zudem können mit den Schaltflächen „Add Entry“ und „Add Text Entry“ weitere Startparameter einzeln gesetzt werden:



terminate

Wenn CIB doXiview beendet werden soll, kann es notwendig sein, dass abschließend Daten über die beendete Sitzung an den Master übermittelt werden oder dieser auf das Beenden der Dokumentbetrachtung reagieren soll. Dazu ruft CIB doXiview die Funktion terminate auf.

Function

Parameters

Return

 
terminate
 
code: int
data: JSON
errorDescription: String
 
void

This method must be called when the application finishes/closes. Once this method has been called, the application status will be set to CLOSED and subsequent calls to functions will fail.

Parameter description:

  • int: code:
    The terminate code.
  • JSON: data:
    Any data to pass back, e.g. viewer settings.
  • String: errorDescription:
    A description of the error if an error occurred.

Registration by Master:

master.common.registerTerminateCallback(callback: FunctionCallback);

fireDataDirty

In CIB doXiview können Änderungen vorliegen, die der Benutzer noch nicht gespeichert hat. Beispiele hierfür sind noch nicht gespeicherte Annotationen oder ein geändertes RTF-Freitextfeld. Damit der Master darauf reagieren kann, ruft CIB doXiview die Funktion fireDataDirty auf.

Function

Parameters

Return

 
fireDataDirty

 
isDataDirty: boolean
message: String
messageId: int

 
void

Informs the integrator that there are unsaved changes in CIB doXiview which can for instance be unsaved changes within the editor component after the user edited a RTF-Snippet.

Parameter description:

  • boolean: isDataDirty:
    Whether or not there are unsaved changes in CIB doXiview.
  • String: message:
    The message which will be presented to the user if the integrator application is tried to be closed without saving. 
  • int: messageId:
    The id of the message so that it can be overridden if necessary by the integrator

Registration by master:

master.common.registerFireDataDirtyCallback(callback: FunctionCallback);

lock, unlock

Es kann erforderlich sein, die gesamte CIB doXiview Benutzeroberfläche zu sperren um sie gegen unbefugte Eingaben zu schützen. Beispielsweise durch eine explizite Sperranforderung des Benutzers oder wenn der Benutzer längere Zeit inaktiv war. Ein späteres Entsperren der Oberfläche ist ebenfalls möglich. Beides wird durch den Master veranlasst.

Function

Parameters

Return

 
lock

 
N/A

 
void

Tells the client application to lock itself.

Registration by slave:

slave.common.registerLockCallback(callback: FunctionCallback);

 

Function

Parameters

Return

 
unlock

 
N/A

 
void

Tells the client application to unlock itself.

Registration by slave:

slave.common.registerUnlockCallback(callback: FunctionCallback);

logout

Wird in der Master-Anwendung ein Logout des Benutzers durchgeführt, sollte CIB doXiview darüber informiert werden, z. B. um einen eventuell geöffneten Freitext-Editor schließen.

Slave Interface:

Function

Parameters

Return

 
logout

 
N/A

 
void

Tells the client application to logout.

Registration by slave:

slave.common.registerLogoutCallback(callback:FunctionCallback);

resize

In CIB doXiview ist es möglich, die Größe der Anwendung anzupassen. Dies wird durch einen Aufruf der Funktion resize realisiert.

Slave Interface:

Function

Parameters

Return

 
resize

 
width: int
height: int

 
void

Lets CIB doXiview resize to the specified size in pixel.


Parameter description:

  • int: width:
    The new width of the application.
  • int: height:
    The new height of the application.

Registration by slave:

slave.common.registerResizeCallback(callback: FunctionCallback);

showMessage

Der Master kann die Funktion showMessage aufrufen, um in CIB doXiview Nachrichten für den Benutzer anzuzeigen. Diese werden über dem Dokument eingeblendet und nach einer gewissen Zeit automatisch ausgeblendet.

Function

Parameters

Return

 
showMessage

 
messageText: String

 
void

Lets CIB doXiview display the specified message text.

Parameter description:

  • String: messageText:
    The message to show.

Registration by slave:

slave.common.registerShowMessageCallback(callback: FunctionCallback);