Udostępnij przez

Schemat JSON definicji agenta dla uruchamiania agentów w systemie Windows

W tym artykule opisano format pliku JSON definicji agenta dla uruchamiania agentów w systemie Windows. Ten plik musi być uwzględniony w projekcie z ustawieniem Akcja kompilacji na wartość "Zawartość" i skopiuj do katalogu wyjściowego na wartość "Kopiuj, jeśli jest nowsza". Określ ścieżkę względną pakietu do pliku JSON w pliku XML manifestu pakietu.

Rejestracja agenta uruchamiania łączy agenta z akcją aplikacji, która obsługuje wywołanie agenta. Aby uzyskać informacje na temat tworzenia akcji aplikacji, zobacz Wprowadzenie do uruchamiania agentów w systemie Windows.

Przykładowy plik JSON definicji agenta

{ 
  "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"
}

Właściwości JSON definicji agenta

W poniższej tabeli opisano właściwości pliku JSON definicji agenta.

Katalog główny dokumentu

Majątek Typ Description Required
manifest_version ciąg Wersja schematu manifestu definicji agenta. Bieżąca wersja to "0.1.0". Tak
wersja ciąg Wersja agenta. Użyj semantycznego przechowywania wersji (np. "1.0.0"). Tak
nazwa ciąg Unikatowy identyfikator agenta, zazwyczaj używając notacji odwrotnej domeny (np. "Zava.ZavaAgent"). Ta wartość nie jest lokalizowalna i musi być unikatowa w pakiecie. Tak
display_name ciąg Nazwa wyświetlana dla agenta wyświetlana wyświetlana dla użytkownika. Ta wartość jest lokalizowalna przy użyciu ms-resource:// formatu w celu odwołania się do zasobu ciągu w pakiecie aplikacji. Tak
opis ciąg Opis agenta dostępny dla użytkownika. Ta wartość jest lokalizowalna przy użyciu ms-resource:// formatu w celu odwołania się do zasobu ciągu w pakiecie aplikacji. Tak
icon ciąg Ikona agenta. Ta wartość jest lokalizowana przy użyciu ms-resource:// formatu, aby odwoływać się do zasobu ikony wdrożonego z pakietem aplikacji. Tak
action_id ciąg Identyfikator akcji aplikacji, która będzie obsługiwać wywołania tego agenta. Musi to być zgodne z id polem akcji zdefiniowanej w tym samym pakiecie aplikacji. Aby uzyskać informacje na temat tworzenia skojarzonej akcji aplikacji, zobacz Wprowadzenie do uruchamiania agentów w systemie Windows. Tak

Lokalizacja

Właściwości display_name, descriptioni icon obsługują lokalizację za pomocą schematu identyfikatora ms-resource:// URI. Dzięki temu można udostępniać zlokalizowane ciągi i zasoby dla różnych języków.

Zasoby ciągów

Aby zlokalizować właściwości ciągu, użyj następującego formatu:

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

Nazwa zasobu odpowiada zasobowi ciągu zdefiniowanemu w plikach zasobów pakietu aplikacji (.resw plikach projektów języka C# lub .rc plikach dla projektów C++).

Zasoby ikon

Aby zlokalizować właściwości ikony, użyj następującego formatu:

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

Ścieżka jest względna względem katalogu głównego pakietu i może odwoływać się do różnych ikon dla różnych języków za pośrednictwem systemu zasobów aplikacji.

Relacja z akcjami aplikacji

Każdy moduł uruchamiający agenta musi odwoływać się do akcji aplikacji za pośrednictwem action_id właściwości . Akcja aplikacji definiuje sposób wywoływanego agenta, w tym:

  • Wymagane jednostki wejściowe (agentName i prompt)
  • Opcjonalne jednostki wejściowe (takie jak attachedFile)
  • Mechanizm wywołania (aktywacja identyfikatora URI lub COM)

Akcja aplikacji i uruchamianie agenta muszą znajdować się w tym samym pakiecie aplikacji. Po wywołaniu uruchamiania agenta system używa action_id elementu , aby zlokalizować odpowiednią akcję aplikacji i wywołuje ją przy użyciu odpowiednich danych wejściowych.

Aby uzyskać szczegółowe informacje na temat tworzenia akcji aplikacji dla uruchamiania agenta, zobacz Wprowadzenie do uruchamiania agentów w systemie Windows.

  • Last updated on