outsystems-ui - v2.30.0
    Preparing search index...

    Interface IProviderPattern<P>

    Defines the interface for OutSystemsUI Providers

    IProviderPattern

    interface IProviderPattern<P> {
        build(): void;
        dispose(): void;
        isBuilt: boolean;
        selfElement: HTMLElement;
        uniqueId: string;
        widgetId: string;
        changeProperty(propertyName: string, propertyValue: unknown): void;
        registerCallback(eventName: string, callback: OSGeneric): void;
        provider: P;
        providerInfo: ProviderInfo;
        setProviderConfigs(newConfigs: any): void;
        updateProviderEvents(providerInfo: ProviderInfo): void;
        equalsToID(id: string): boolean;
    }

    Type Parameters

    • P

    Hierarchy (View Summary)

    Implemented by

    Index
    isBuilt selfElement uniqueId widgetId provider providerInfo
    build dispose changeProperty registerCallback setProviderConfigs updateProviderEvents equalsToID
    isBuilt: boolean

    Indicates if the instance of the pattern is built.

    OSFramework.Interface.IPattern

    selfElement: HTMLElement

    Pattern HTML element

    OSFramework.Interface.IPattern

    uniqueId: string

    Internal Id of the instance of the pattern.

    OSFramework.Interface.IPattern

    widgetId: string

    External Id of the instance of the pattern

    OSFramework.Interface.IPattern

    provider: P

    Attribute that keeps the instance of the provider of the pattern.

    OSFramework.Interface.IProviderPattern

    providerInfo: ProviderInfo

    Attribute that keeps the information about the provider version

    OSFramework.Interface.IProviderPattern

    • Method signature to change the properties/configs of the pattern.

      Parameters

      • propertyName: string
      • propertyValue: unknown

      Returns void

      OSFramework.Interface.IPattern

    • Method to enable extensibility to provider supported configs

      Parameters

      • newConfigs: any

      Returns void

      OSFramework.Interface.IProviderPattern

    • Method to update the provider events API instance and save/pending events

      Parameters

      • providerInfo: ProviderInfo

      Returns void

      OSFramework.Interface.IProviderPattern

    Settings
    Member Visibility

    On This Page
    Properties
    Methods