Interface ISnippetApi

API for working with snippets

interface ISnippetApi {
    _apiId: "mendix.SnippetApi";
    addEventListener<K>(eventType: K, listener: EventHandler<{}, K>): DisposeListener;
    addSnippet(containerId: string, options?: SnippetCreationOptions): Promise<string>;
    applyChanges(operations: Operation[]): Promise<ApplyChangesResult>;
    createElement<TElement>(type: TElement["$Type"], options?: TElement["$CreationOptions"]): Promise<TElement>;
    createUnit(type: "Pages$Snippet", containerId: string, options?: SnippetCreationOptions): Promise<Snippet>;
    deleteUnit(unitId: string): Promise<void>;
    getElementMetadata(): Promise<ElementMetadataMap>;
    loadUnits(type: "Pages$Snippet", unitIds: string[]): Promise<Snippet[]>;
    removeEventListener<K>(eventType: K, listener: EventHandler<{}, K>): void;
}

Hierarchy

  • IModelComponentApiBase<Snippet>
    • ISnippetApi

Properties

_apiId

Methods

addEventListener addSnippet applyChanges createElement createUnit deleteUnit getElementMetadata loadUnits removeEventListener

Properties

_apiId

_apiId

Unique identifier that can be used to register or retrieve a specific API.

Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

Methods

addEventListener

  • addEventListener<K>(eventType, listener): DisposeListener

  • Adds an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to listen for.

    • listener: EventHandler<{}, K>

      The event listener to add.

    Returns DisposeListener

    A function that can be called to remove the event listener.

addSnippet

  • addSnippet(containerId, options?): Promise<string>

  • Adds a snippet to the specified container.

    Parameters

    • containerId: string

      The ID of the container where the snippet will be added. It could be a module or folder.

    • Optionaloptions: SnippetCreationOptions

      Options for that will be used during the snippet initilization.

    Returns Promise<string>

    A promise that resolves to the ID of the newly created snippet.

applyChanges

  • applyChanges(operations): Promise<ApplyChangesResult>

  • Parameters

    • operations: Operation[]

    Returns Promise<ApplyChangesResult>

createElement

  • createElement<TElement>(type, options?): Promise<TElement>

  • Type Parameters

    Parameters

    Returns Promise<TElement>

createUnit

  • createUnit(type, containerId, options?): Promise<Snippet>

  • Parameters

    Returns Promise<Snippet>

deleteUnit

  • deleteUnit(unitId): Promise<void>

  • Parameters

    • unitId: string

    Returns Promise<void>

getElementMetadata

  • getElementMetadata(): Promise<ElementMetadataMap>

  • Returns Promise<ElementMetadataMap>

loadUnits

  • loadUnits(type, unitIds): Promise<Snippet[]>

  • Parameters

    • type: "Pages$Snippet"
    • unitIds: string[]

    Returns Promise<Snippet[]>

removeEventListener

  • removeEventListener<K>(eventType, listener): void

  • Removes an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to remove the listener from.

    • listener: EventHandler<{}, K>

      The event listener to remove.

    Returns void

Settings

On This Page

Properties
Methods