Skip to content

Latest commit

 

History

History
79 lines (70 loc) · 5.03 KB

extension.service.md

File metadata and controls

79 lines (70 loc) · 5.03 KB
Raw
Title Added Status Last reviewed
Extension Service
v3.0.0
Experimental
2019-03-19

Extension Service

Manages and runs basic extension functionality.

Class members

Methods

  • evaluateRule(ruleId: string, context?: RuleContext): boolean
    Evaluates a rule.

    • ruleId: string - ID of the rule to evaluate
    • context: RuleContext - (Optional) Custom rule execution context.
    • Returns boolean - True if the rule passed, false otherwise

  • getActionById(id: string): ActionRef
    Retrieves an action using its ID value.

    • id: string - The ID value to look for
    • Returns ActionRef - Action or null if not found

  • getAuthGuards(ids: string[]): Array<Type<any>>
    Retrieves one or more auth guards using an array of ID values.

    • ids: string[] - Array of ID value to look for
    • Returns Array<Type<any>> - Array of auth guards or empty array if none were found

  • getComponentById(id: string): Type<>
    Retrieves a registered extension component using its ID value.

    • id: string - The ID value to look for
    • Returns Type<> - The component or null if not found

  • getElements(key: string, fallback: Array<> = []): Array<>

    • key: string -
    • fallback: Array<> -
    • Returns Array<> -

  • getEvaluator(key: string): RuleEvaluator
    Retrieves a RuleEvaluator function using its key name.

  • getFeature(key: string|string[], defaultValue: any = [])
    Gets features by key.

    • key: string|string[] - Key string using dot notation or array of strings
    • defaultValue: any - Default value returned if feature is not found, default is empty array

  • getRouteById(id: string): RouteRef
    Retrieves a route using its ID value.

    • id: string - The ID value to look for
    • Returns RouteRef - The route or null if not found

  • getRuleById(id: string): RuleRef
    Retrieves a rule using its ID value.

    • id: string - The ID value to look for
    • Returns RuleRef - The rule or null if not found

  • load(): Promise<ExtensionConfig>
    Loads and registers an extension config file and plugins (specified by path properties).

  • runExpression(value: string|any, context?: any): any
    Runs a lightweight expression stored in a string.

    • value: string|any - String containing the expression or literal value
    • context: any - (Optional) Parameter object for the expression with details of app state
    • Returns any - Result of evaluated expression, if found, or the literal value otherwise

  • setAuthGuards(values: Function)
    Adds one or more new auth guards to the existing set.

    • values: Function - The new auth guards to add

  • setComponents(values: Function)
    Adds one or more new components to the existing set.

    • values: Function - The new components to add

  • setEvaluators(values: Function)
    Adds one or more new rule evaluators to the existing set.

    • values: Function - The new evaluators to add

  • setup(config: ExtensionConfig)
    Registers extensions from a config object.

Details

Use the methods of this service to add extensibility features to your app. You can find further details in the App extensions page.