Lietotāja makro objekts

Tālāk norādītie objekti ir tieši saistīti ar usermacro API.

Globālais makross

Globālā makrosa objektam ir šādas īpašības.

Īpašība Tips Apraksts
globalmacroid ID Globālā makrosa ID.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas operācijām
description string Makrosa apraksts.
macro string Makrosa virkne.

Īpašības darbība:
- obligāts izveides operācijām
type integer Makrosa tips.

Iespējamās vērtības:
0 - (noklusējums) Teksta makross;
1 - Slepenais makross;
2 - Vault noslēpums.
value string Makrosa vērtība.

Īpašības darbība:
- tikai rakstāms, ja type ir iestatīts uz "Secret macro"
- obligāts izveides operācijām

Hosta makross

Hosta makrosa objekts definē makrosu, kas ir pieejams hostā, hosta prototipā vai veidnē. Tam ir šādas īpašības.

Īpašība Type Apraksts
hostmacroid ID Makrosa ID.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas operācijām
automatic integer Nosaka, vai makrosu kontrolē atklāšanas kārtula.

Iespējamās vērtības:
0 - (noklusējums) Makrosu pārvalda lietotājs;
1 - Makrosu pārvalda atklāšanas kārtula.

Lietotājam nav atļauts izveidot automātisku makrosu.
Lai atjauninātu automātisku makrosu, tas ir jāpārveido par manuālu.
config object/array Makrosa konfigurācija, kas nosaka, kā makross tiek attēlots Host Wizard.
description string Makrosa apraksts.
hostid ID Hosta, hosta prototipa vai veidnes ID, kuram pieder makross.

Īpašības darbība:
- konstants
- obligāts izveides operācijām
macro string Makrosa virkne.

Īpašības darbība:
- obligāts izveides operācijām
type integer Makrosa tips.

Iespējamās vērtības:
0 - (noklusējums) Teksta makross;
1 - Slepens makross;
2 - Vault noslēpums.
value string Makrosa vērtība.

Īpašības darbība:
- tikai rakstāms, ja type ir iestatīts uz "Secret macro"
- obligāts izveides operācijām

Makro konfigurācija

Makro konfigurācijas objekts nosaka, kā makro tiek attēlots Host Wizard.

Īpašība Tips Apraksts
type integer Makro ievades lauka tips.

Iespējamās vērtības:
0 - Makro netiek izmantots Host Wizard;
1 - Teksta lauks;
2 - Saraksts;
3 - Izvēles rūtiņa.

Īpašības darbība:
- obligāts
label string Makro ievades lauka etiķete.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Textbox", "List" vai "Checkbox"
description text Palīdzības teksts, kas tiek parādīts blakus makro ievades laukam. Atbalsta Markdown formatējumu.
priority integer Makro ievades lauka pozīcija makro sarakstā.

Ja priority nav iestatīts, makro tiek pievienots negrupēto makro saraksta beigās.
required integer Norāda, ka makro ir obligāts.

Iespējamās vērtības:
0 - Nav obligāts;
1 - Obligāts.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Textbox" vai "List"
regex string Regulārā izteiksme lietotāja ievades pārbaudei teksta laukā.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Textbox"
section_name string Sakļaujamās sadaļas etiķete, kurā makro tiek grupēts.

Ja section_name nav iestatīts, makro netiek grupēts. Negrupētie makro tiek parādīti vispirms; grupētie makro tiek parādīti zemāk, sakārtoti pēc to priority katrā sakļaujamajā sadaļā.
options text JSON virkne, kas definē saraksta vienumus vai izvēles rūtiņas vērtības.

Sarakstiem: objektu masīvs ar value un text īpašībām.
Piemērs: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

Izvēles rūtiņām: objekts ar checked un unchecked īpašībām.
Piemērs: {"checked": true, "unchecked": false}

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "List" vai "Checkbox"