signoMobileCapture – Klasse MobileDevice

Allgemeine Informationen

Die Klasse MobileDevice repräsentiert ein mobiles Gerät. Sie enthält Methoden zum Herstellen und Trennen einer Verbindung zu diesem Gerät sowie zum Starten und Steuern des Unterschriftenvorgangs. Ferner bietet Sie eine Reihe von Eigenschaften und Events.

Eigenschaft Name

Diese Eigenschaft stellt den Namen des mobilen Geräts zur Verfügung.

string Name;

Eigenschaft DeviceMaker

Diese Eigenschaft stellt Namen des Geräteherstellers des mobilen Gerätes zur Verfügung.

string DeviceMaker;

Eigenschaft DeviceVersion

Diese Eigenschaft stellt die Betriebssystemversion des mobilen Geräts zur Verfügung.

string DeviceVersion;

Eigenschaft DeviceModel

Diese Eigenschaft stellt die Modellbezeichnung des mobilen Geräts zur Verfügung.

string DeviceModel;

Eigenschaft Width

Diese Eigenschaft stellt die Breite des Displays des mobilen Geräts zur Verfügung.

int Width;

Eigenschaft Height

Diese Eigenschaft stellt die Höhe des Displays des mobilen Geräts zur Verfügung.

int Height

Eigenschaft SignatureResolution

Diese Eigenschaft enthält die Auflösung des Signaturbildes.

double SignatureResolution;

Eigenschaft SignatureWidth

Diese Eigenschaft enthält die Breite des Signaturbildes.

int SignatureWidth;

Eigenschaft SignatureHeight

Diese Eigenschaft erlaubt das Auslesen und Setzen der gewünschten Höhe des Signaturbildes.

int SignatureHeight;

Eigenschaft SignaturePenColor

Diese Eigenschaft enthält die Farbe der Signatur.

Die hier gewählte Farbe wird sowohl von der Echtzeitansicht der Apps (Android und iOS ab Version 2.2.0), als auch dem Control und dem gerenderten Signaturbild berücksichtigt.

System.Drawing.Color SignaturePenColor;

Anwendungsbeispiel:

SignaturePenColor = Color.FromKnownColor(KnownColor.Blue);

Eigenschaft VariablePenWidth

Diese Eigenschaft steuert, ob die Unterschrift im gerenderten Bild mit einer variablen Strichstärke dargestellt wird.

bool VariablePenWidth;

Eigenschaft SignatureTransparency

Diese Eigenschaft legt fest, ob der Hintergrund des gerenderten Signaturbilds transparent oder weiß sein soll.

bool SignatureTransparency;

Eigenschaft Connected

Diese Eigenschaft gibt an, ob derzeit eine Verbindung zu einem Gerät besteht.

bool Connected;

Eigenschaft SignaturePenWidth

Diese Eigenschaft enthält die Strichstärke der Unterschrift beim Rendern.

int SignaturePenWidth;

Eigenschaft SignatureMustBeConfirmed

Diese Eigenschaft bestimmt, ob eine Unterschrift über das API bestätigt werden muss. Wenn ja, wird bei einer Bestätigung über die mobile App durch das Event SignatureConfirmed nur die Anzahl der Signaturpunkte gesendet.

Bool SignatureMustBeConfirmed

Methode Dispose

Die Dispose-Methode sollte aufgerufen werden, sobald die Instanz nicht länger benötigt wird. Hierdurch wird eine gegebenenfalls noch aufgebaute Verbindung zu diesem Gerät beendet und es werden verschiedene Aufräumarbeiten verrichtet.

void Dispose();

Methode Connect

Die Connect-Methode stellt eine Verbindung zu einem mobilen Gerät her und führt den Handshake durch. Da diese Vorgänge asynchron ablaufen, liefert diese Methode keinen Rückgabewert und blockiert auch nicht den Programmlauf beziehungsweise Thread. Ob und wann eine Verbindung aufgebaut werden konnte, kann im Anschluss durch das Event DeviceConnected geprüft werden.

void Connect(string pairingCode);

Methode Disconnect

Die Disconnect-Methode beendet die Verbindung zu dem mobilen Gerät.

void Disconnect();

Methode CaptureSignature

Diese Methode startet den Signaturvorgang auf dem mobilen Gerät. Wenn ein Bestätigungstext übergeben wurde, wird zunächst dieser auf dem mobilen Gerät angezeigt. Der eigentliche Signaturvorgang startet in diesem Falle nur, wenn der Text akzeptiert wurde.

Wenn der Signaturvorgang im mobilen Gerät beginnt, wird das Event SigningStarted aufgerufen. Im Fall, dass ein Bestätigungstext vorgeschalteten wurde, geschieht das genau dann (und auch nur dann), wenn der Bestätigungstext akzeptiert wurde. Es ist also unter Umständen ratsam, entsprechende weitere Programmschritte im entsprechenden Event-Handler vorzunehmen und nicht unmittelbar nach dem Aufruf dieser Methode.

Wird diese Methode aufgerufen, ohne dass eine Verbindung zum Gerät aufgebaut wurde, wird eine Ausnahme geworfen.

void CaptureSignature();
void CaptureSignature(string confirmationText);

Methode RetrySignature

Diese Methode verwirft alle bisher erfassten Unterschriftsdaten und löscht die Unterschrift vom Display des mobilen Geräts. Das mobile Gerät verbleibt aber im Signaturvorgang.

Wenn der Signaturvorgang im mobilen Gerät neu gestartet wird, wird das Event SignatureRetry aufgerufen.

Wird diese Methode aufgerufen, ohne dass eine Verbindung zum Gerät aufgebaut wurde, wird eine Ausnahme geworfen.

void RetrySignature();

Methode CancelSignature

Die Methode CancelSignature verwirft alle bisher erfassten Unterschriftsdaten. Das mobile Gerät verlässt den Signaturvorgang.

Wenn der Signaturvorgang im mobilen Gerät abgebrochen wird, wird das Event SigningCanceled aufgerufen.

Wird diese Methode aufgerufen, ohne dass eine Verbindung zum Gerät aufgebaut wurde, wird eine Ausnahme geworfen.

void CancelSignature();

Methode ConfirmSignature

Diese Methode übernimmt die erfassten Unterschriftsdaten. Das mobile Gerät verlässt den Signaturvorgang. Die erfassten Unterschriftsdaten sowie ein gerendertes Bild der Unterschrift werden im Anschluss über das Event SignatureConfirmed bereitgestellt.

Wird diese Methode aufgerufen, ohne dass eine Verbindung zum Gerät aufgebaut wurde, wird eine Ausnahme geworfen.

void ConfirmSignature();

Event DeviceConnected

Dieses Event wird immer dann aufgerufen, wenn der Versuch, eine Verbindung mit dem mobilen Gerät herzustellen, beendet wurde.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.DeviceConnected += new DeviceConnectedHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, DeviceConnectedEventArgs e);

Die Klasse DeviceConnectedEventArgs enthält folgende Membervariablen:

Event SigningStarted

Dieses Event wird immer dann aufgerufen, wenn der Signaturvorgang im mobilen Gerät gestartet wird. Im Falle eines vorgeschalteten Bestätigungstextes (siehe CaptureSignature) gibt es somit auch Aufschluss darüber, ob und wann dieser vom Bediener akzeptiert wurde.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.SigningStarted += new EventHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, EventArgs e);

Event SignatureRetry

Dieses Event wird immer dann aufgerufen, wenn der Signaturvorgang im mobilen Gerät wiederholt wird.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.SignatureRetry += new EventHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, EventArgs e);

Event SigningCanceled

Dieses Event wird immer dann aufgerufen, wenn der Signaturvorgang im mobilen Gerät abgebrochen wurde, egal ob dies durch den Button im mobilen Gerät oder durch den Aufruf der Methode CancelSignature ausgelöst wurde.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.SigningCanceled += new EventHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, EventArgs e);

Event SignatureConfirmed

Dieses Event wird immer dann aufgerufen, wenn die im mobilen Gerät erfasste Unterschrift bestätigt wurde, egal ob dies durch den Button im mobilen Gerät oder durch den Aufruf der Methode ConfirmSignature ausgelöst wurde.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.SignatureConfirmed += new SignatureConfirmedHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, SignatureConfirmedEventArgs e);

Die Klasse SignatureConfirmedEventArgs enthält folgende Membervariablen:

Event SignatureDataReceived

Dieses Event wird immer dann aufgerufen, wenn im Rahmen der Unterschriftenerfassung neue Punkte im mobilen Gerät erfasst und an den PC übermittelt wurden. Die neu erfassten Punkte werden in einer Liste in den Event-Parametern geliefert. Damit kann auf Ereignisse während des Unterschreibens reagiert werden, zum Beispiel nachdem eine bestimmte Anzahl von Punkten erfasst wurde oder wenn das Unterschreiben für längere Zeit unterbrochen wurde.

Aus Gründen der Sicherheit enthalten die durch dieses Event bereitgestellten Punkte keine Zeitwerte. Eine Rekonstruktion der biometrischen Daten durch den Mitschnitt dieser unverschlüsselten Informationen ist somit nicht möglich.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.SignatureDataReceived += new SignatureDataReceivedHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, SignatureDataReceivedEventArgs  e);

Die Klasse SignatureDataReceivedEventArgs enthält folgende Membervariablen:

Die Klasse SigPoint enthält folgende Membervariablen:

Event BonjourError

Dieses Event wird immer dann aufgerufen, wenn eine der asynchronen Bonjour-Methoden einen entsprechenden Fehler meldet.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.BonjourError += new BonjourErrorHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, BonjourErrorEventArgs e);

Die Klasse BonjourErrorEventArgs enthält folgende Membervariablen:

Event MobileCaptureError

Dieses Event wird immer dann aufgerufen, wenn eine asynchrone interne Methode des laufenden Services eine Ausnahme wirft.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

%MOBILECAPTURE_NAME%.MobileCaptureError += new MobileCaptureErrorHandler(%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, MobileCaptureErrorEventArgs e);

Die Klasse MobileCaptureErrorEventArgs enthält folgende Membervariablen: