Benutzerdefiniertes URL-Protokoll

URL_SCHEME ist der Tenant-Name in Kleinbuchstaben (z. B. idgard).

idgard Sync registriert ein benutzerdefiniertes URL-Protokoll (URL_SCHEME://), das es ermöglicht, Anwendungsaktionen direkt über Links in E-Mails, Webseiten oder anderen Anwendungen auszulösen. Ist der Protokoll-Handler registriert, startet ein Klick auf einen URL_SCHEME://-Link das idgard Sync-CLI-Tool idgard-cli.exe und führt den entsprechenden Befehl aus.

Aktivierung

Der benutzerdefinierte URL-Protokoll-Handler ist standardmäßig deaktiviert. Er kann über die Einstellung CustomUrlProtocolEnabled in der Anwendungskonfiguration aktiviert werden. Nach der Aktivierung registriert die Anwendung das URL_SCHEME://-Schema in der Windows-Registrierung unter HKEY_CURRENT_USER – Administratorrechte sind nicht erforderlich.

URL-Format

URL_SCHEME://<command>[/<primary>][?<key>=<value>&<keyN>=<valueN>]

<command> – Die auszuführende Aktion (siehe Befehle unten).
/<primary> – Ein optionales Pfadsegment, das der primären Option des Befehls zugeordnet wird.
?<key>=<value> – Optionale Abfrageparameter, die nach Namen auf CLI-Optionen abgebildet werden. Das ?-Präfix kennzeichnet den Beginn des Query-Strings und ist vor dem ersten Parameter erforderlich.
&<keyN>=<valueN> – Weitere Abfrageparameter, getrennt durch &. Auf diese Weise können mehrere Parameter aneinandergereiht werden.

Note

Das Schema-Präfix lautet immer URL_SCHEME://. Pfadwerte und Abfrageparameter sind URL-kodiert.

Häufige URL-Kodierungen

Zeichen	Kodiert	Beschreibung
Leerzeichen	`%20`	Wird in Ordner- oder Dateinamen mit Leerzeichen verwendet.
`:`	`%3A`	Doppelpunkt – erscheint nach dem Laufwerksbuchstaben (z. B. `C%3A`).
`\`	`%5C`	Rückwärtiger Schrägstrich – Windows-Pfadtrennzeichen.
`/`	`%2F`	Vorwärtiger Schrägstrich – alternatives Pfadtrennzeichen.
`?`	`%3F`	Fragezeichen – muss innerhalb von Pfadsegmenten kodiert werden.
`&`	`%26`	Kaufmännisches Und – muss innerhalb von Abfrageparameterwerten kodiert werden.
`=`	`%3D`	Gleichheitszeichen – muss innerhalb von Abfrageparameterwerten kodiert werden.

Verfügbare Befehle

Im Explorer anzeigen (`_reveal`)

Öffnet den Windows Explorer am angegebenen Pfad. Zeigt der Pfad auf eine Datei, wird die Datei im übergeordneten Ordner markiert. Ohne Pfadangabe wird der Synchronisierungsordner geöffnet.

Parameter	CLI-Option	Beschreibung
path (optional)	`--path`	Absoluter Pfad oder Pfad relativ zum Synchronisierungsordner.

Beispiele:

<!-- Öffnet den Synchronisierungsordner im Windows Explorer -->
URL_SCHEME://_reveal

<!-- Öffnet den Windows Explorer mit C:\Users\me\Documents\report.pdf markiert (absoluter Pfad) -->
URL_SCHEME://_reveal/C%3A%5CUsers%5Cme%5CDocuments%5Creport.pdf

<!-- Öffnet den Windows Explorer bei MyBox\report.pdf relativ zum Synchronisierungsordner -->
URL_SCHEME://_reveal/MyBox%5Creport.pdf

Echte Beispiele:

Zeige Synchronisierungsordner im Windows Explorer.
Zeige Erste Schritte.pdf im Windows Explorer.

Im Web öffnen (`_nav`)

TENANT_NAME ist "idgard".

Öffnet ein idgard-Element im Webfrontend über den Standard-Browser des Systems.

Parameter	CLI-Option	Beschreibung
id	`--id`	Die idgard-Element-ID.
hostname	`--hostname`	Der idgard-Serverhostname (z. B. `TENANT_NAME`).
user-id	`--user-id`	Die idgard-Benutzer-ID.
action (optional)	`--action`	Die auszuführende Aktion: `NavigateTo` (Standard) oder `Settings`.