Freigeben über

JSON-Schema der Agentdefinition für Agent-Startprogramme unter Windows

In diesem Artikel wird das Format der JSON-Datei der Agentdefinition für Agent-Startprogramme unter Windows beschrieben. Diese Datei muss in Ihrem Projekt enthalten sein, wobei die Buildaktion auf "Inhalt" und "In Ausgabeverzeichnis kopieren " auf "Kopieren, wenn neuer" festgelegt ist. Geben Sie den paketrelativen Pfad zur JSON-Datei in der XML-Paketmanifestdatei an.

Eine Agent-Startprogrammregistrierung verknüpft einen Agent mit einer App-Aktion, die den Agentaufruf behandelt. Informationen zum Erstellen der App-Aktion finden Sie unter "Erste Schritte mit Agent-Startern unter Windows".

JSON-Beispieldatei für die Agentdefinition

{ 
  "manifest_version": "0.1.0", 
  "version": "1.0.0", 
  "name": "Zava.ZavaAgent", 
  "display_name": "ms-resource://zavaAgentDisplayName", 
  "description": "ms-resource://zavaAgentDescription", 
  "icon": "ms-resource://Files/Assets/ZavaLogo.png", 
  "action_id": "ZavaAgentAction"
}

JSON-Eigenschaften der Agentdefinition

In der folgenden Tabelle werden die Eigenschaften der JSON-Datei der Agentdefinition beschrieben.

Dokumentstamm

Eigentum Typ Description Erforderlich
manifest_version Schnur Die Schemaversion des Agentdefinitionsmanifests. Die aktuelle Version ist "0.1.0". Yes
Ausgabe Schnur Die Version Ihres Agents. Verwenden Sie die semantische Versionsverwaltung (z. B. "1.0.0"). Yes
name Schnur Ein eindeutiger Bezeichner für Ihren Agent, in der Regel mithilfe der Reversedomänennotation (z. B. "Zava.ZavaAgent"). Dieser Wert ist nicht lokalisierbar und muss innerhalb Des Pakets eindeutig sein. Yes
display_name Schnur Der anzeigename des Benutzers für den Agent. Dieser Wert kann mithilfe des ms-resource:// Formats lokalisiert werden, um auf eine Zeichenfolgenressource in Ihrem App-Paket zu verweisen. Yes
Beschreibung Schnur Eine benutzerorientierte Beschreibung der Funktionsweise des Agents. Dieser Wert kann mithilfe des ms-resource:// Formats lokalisiert werden, um auf eine Zeichenfolgenressource in Ihrem App-Paket zu verweisen. Yes
Ikone Schnur Das Symbol für den Agent. Dieser Wert ist mithilfe des Formats lokalisierbar, um auf eine Symbolressource zu verweisen, die ms-resource:// mit Ihrem App-Paket bereitgestellt wird. Yes
action_id Schnur Der Bezeichner der App-Aktion, die Aufrufe dieses Agents behandelt. Dies muss mit dem id Feld einer Aktion übereinstimmen, die im selben App-Paket definiert ist. Informationen zum Erstellen der zugeordneten App-Aktion finden Sie unter "Erste Schritte mit Agent-Startprogrammen unter Windows". Yes

Lokalisierung

Das display_name, descriptionund icon die Eigenschaften unterstützen die Lokalisierung über das ms-resource:// URI-Schema. Auf diese Weise können Sie lokalisierte Zeichenfolgen und Ressourcen für verschiedene Sprachen bereitstellen.

Zeichenfolgenressourcen

Verwenden Sie zum Lokalisieren von Zeichenfolgeneigenschaften das folgende Format:

"display_name": "ms-resource://resourceName"

Der Ressourcenname entspricht einer Zeichenfolgenressource, die in den Ressourcendateien Ihres App-Pakets definiert ist (.resw Dateien für C#-Projekte oder .rc Dateien für C++-Projekte).

Symbolressourcen

Verwenden Sie zum Lokalisieren von Symboleigenschaften das folgende Format:

"icon": "ms-resource://Files/Assets/iconName.png"

Der Pfad ist relativ zum Paketstamm und kann über das Ressourcensystem Ihrer App auf unterschiedliche Symbole für unterschiedliche Sprachen verweisen.

Beziehung zu App-Aktionen

Jedes Agent-Startprogramm muss über die action_id Eigenschaft auf eine App-Aktion verweisen. Die App-Aktion definiert, wie der Agent aufgerufen wird, einschließlich:

  • Erforderliche Eingabeentitäten (agentName und prompt)
  • Optionale Eingabeentitäten (z. B attachedFile. )
  • Der Aufrufmechanismus (URI-Aktivierung oder COM)

Das App-Aktions- und Agent-Startprogramm muss sich im selben App-Paket befinden. Wenn ein Agent-Startfeld aufgerufen wird, verwendet das System die action_id entsprechende App-Aktion und ruft es mit den entsprechenden Eingaben auf.

Ausführliche Informationen zum Erstellen der App-Aktion für Ihr Agent-Startfeld finden Sie unter "Erste Schritte mit Agent Launchern unter Windows".

  • Last updated on