Skip to content

General Interface API

Rebecca Madsen edited this page Apr 23, 2018 · 2 revisions
Property Optional Default Purpose Implemented?
id N Automatically generated when creating an interview protocol using Architect Provides a unique identifier for this interface. Used by Network Canvas to determine where a node was created. Y
type N NameGenerator Used by Network Canvas to determine which interface to load for this stage of the interview. Automatically populated when your protocol is built using Architect. When creating a protocol file manually, this must be set to the name of a valid interface, either provided within Network Canvas or defined in your protocol file. Y
icon Y menu-name-generator The icon used to represent this stage in the menu. The default behavior is to use the icon designed to represent a name generator interface, but this can be overridden by the protocol author. Y
label N none Text label that is shown in the Network Canvas stages menu, and to refer to this stage in Architect. Y
skipLogic Y none A network query to determine whether this interface should be skipped or shown. Y