VariantsAPI¶
Interface VariantsAPI
interface VariantsAPI {
isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>;
requestVariants(nodeId: number): Promise<VariantProperties[]>;
setVariantEnabled(variant: number, enabled: boolean): Promise<void>;
}
isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>;
requestVariants(nodeId: number): Promise<VariantProperties[]>;
setVariantEnabled(variant: number, enabled: boolean): Promise<void>;
}
Hierarchy (View Summary)
- VariantsAPI
Methods
is
Parameters
- nodeId: number
Returns Promise<boolean>
True, if the Node is Part of an enabled Variant. False otherwise.
request
Parameters
- nodeId: number
The ID of the Node.
Returns Promise<VariantProperties[]>
The Variant(s) for a given nodeID.
- nodeId: number
set
Enables or disables a given Variant.
Parameters
- variant: number
The ID of the Variant.
- enabled: boolean
The enabled state.
Returns Promise<void>
- variant: number
The ID of the Node.