Member Junction
    Preparing search index...

    Class ValidateEntitySchemaAction

    Base class for all actions. All actions will derive from this class and be instantiated by the ClassFactory within the @memberjunctin/global package.

    // Define a typed context
    interface MyActionContext {
      apiEndpoint: string;
      authToken: string;
    }

    // Create an action with typed params
    export class MyAction extends BaseAction {
      protected async InternalRunAction(params: RunActionParams<MyActionContext>): Promise<ActionResultSimple> {
        // Access typed context
        const endpoint = params.Context?.apiEndpoint;
        const token = params.Context?.authToken;
        
        // Implement action logic
        return {
          Success: true,
          ResultCode: 'SUCCESS',
          Message: 'Action completed'
        };
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    addOutputParam buildPipelineOptions buildPipelineResult checkAuthorization getBoolParam getModificationTypeParam getStringParam getTableDefinitionParam handleUnexpected InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: true

    Checks the caller's Schema Management authorization itself (checkAuthorization).

    Accessors

    • get SupportsAudience(): boolean

      Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone besides the caller who will see its output, such as the other participants of a shared conversation.

      false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller, ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running it. Override to return true only when the action honours the audience in full — every record, snippet and count it returns is something every reader may see (pass the audience to the search engine, check each reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).

      Returns boolean

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods