VariantsAPI¶

Interface VariantsAPI

interface VariantsAPI {
    isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>;
    requestVariants(nodeId: number): Promise<VariantProperties[]>;
    setVariantEnabled(variant: number, enabled: boolean): Promise<void>;
}

Hierarchy (View Summary)

VariantsAPI
- ContextAPI

Index

Methods

isNodePartOfEnabledVariant requestVariants setVariantEnabled

Methods

isNodePartOfEnabledVariant

isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>
Parameters
- nodeId: number
  The ID of the Node.
Returns Promise<boolean>
True, if the Node is Part of an enabled Variant. False otherwise.

requestVariants

requestVariants(nodeId: number): Promise<VariantProperties[]>
Parameters
- nodeId: number
  The ID of the Node.
Returns Promise<VariantProperties[]>
The Variant(s) for a given nodeID.

setVariantEnabled

setVariantEnabled(variant: number, enabled: boolean): Promise<void>
Enables or disables a given Variant.
Parameters
- variant: number
  The ID of the Variant.
- enabled: boolean
  The enabled state.
Returns Promise<void>

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

This page needs code samples
Code samples do not work
Information is missing
Please tell us more about what's wrong:
Information is incorrect
Please tell us more about what's wrong:
Information is unclear or confusing
Please tell us more about what's wrong:
The page is rendered incorrectly (styling/CSS)
Give Feedback