Prev Next

GetItems

Return the full properties for the requested items.

Inputs

Parameter

Details

parameters

  • C++: const char*
  • C#: string

A JSON string of parameters. Includes:

  • itemIDs - a comma separated list of item IDs
  • level - the level hierarchy of the requested menu (starting with 1 for first level)
  • currentID, currentName - the ID and name of the current menu level
  • levelXID - the ID of the menu level X for all previous levels in the hierarchy; that is, level1ID, level2ID
  • levelXName - the name of the menu level X for all previous levels in the hierarchy; that is level1Name, level2Name

Outputs via Callbacks

AddProperty - multiple calls per menu item:

  • AddProperty(index, "id", "item1");
  • AddProperty(index, "name", "Item 1");

Optional extra properties. These can be custom propertyID:propertyValue pairs, eg:

  • AddProperty(index, "notes", "Example notes for item 1");
  • AddProperty(index, "modifiedDate", "2020-04-06T11:33:44");
  • AddProperty(index, "type", "Requirement");
  • AddProperty(index, "url", "http://example.com/item/1");
  • AddProperty(index, "propertyX", "Item 1 Property X");
  • AddProperty(index, "propertyY", "Item 1 Property Y");
  • AddProperty(index, "propertyZ", "Item 1 Property Z");

[Optional] LogMessage or SetError - to provide user feedback.

Details

Return the properties for a list of items. Recommended: If the provider has a way of querying a list of items, then it is recommended to run a single query and return the results. If the provider can't query multiple items, then run multiple individual 'GetItem' calls and concatenate the results.

The returned values should be the same as for GetItem, but specify a unique 'index' value for each different item.