Interface IPublicMethod

Interface for method which should be shown in the UI.

Since

2.0

interface IPublicMethod {
    get Description(): string;
    get DisplayName(): string;
    get MethodCategory(): DataMethodCategory;
    get Name(): string;
    get Section(): string;
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
}

Hierarchy (view full)

Methods

Cast TryCast

Default capability

Description DisplayName MethodCategory Name Section

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

Default capability

Description

  • get Description(): string

  • Gets a description of what the method does. This is shown in the user interface to describe to the user how to use the method.

    Returns string

    Since

    2.0

DisplayName

  • get DisplayName(): string

  • Gets the display name for method name. This is not the name used in expressions but the name shown in the UI.

    Returns string

    Since

    2.0

MethodCategory

Name

  • get Name(): string

  • Gets the name of the method as used in expressions.

    Returns string

    Since

    2.0

Section

Settings

Member Visibility

On This Page

Methods
Default capability