Member Junction
    Preparing search index...

    Class UpdateRecordAction

    Generic action for updating existing entity records in the database. This action provides a flexible way to update records for any entity type by accepting the entity name, primary key, and field values as parameters.

    // Update a customer record
    await runAction({
      ActionName: 'Update Record',
      Params: [
        {
          Name: 'EntityName',
          Value: 'Customers'
        },
        {
          Name: 'PrimaryKey',
          Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
        },
        {
          Name: 'Fields',
          Value: {
            Email: 'newemail@example.com',
            Status: 'Inactive',
            UpdatedAt: new Date()
          }
        }
      ]
    });

    Hierarchy

    • BaseRecordMutationAction
      • UpdateRecordAction
    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    analyzeEntityError getEntityNameParam getEntityObject getFieldsParam getPrimaryKeyParam handleError InternalRunAction loadRecord Run setFieldValues

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    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

    • Updates an existing record for the specified entity type.

      Parameters

      • params: RunActionParams

        The action parameters containing:

        • EntityName (required): The name of the entity to update
        • PrimaryKey (required): Object containing primary key field(s) and value(s)
        • Fields (required): Object containing field names and values to update

      Returns Promise<ActionResultSimple>

      ActionResultSimple with:

      • Success: true if record was updated successfully
      • ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED, NO_CHANGES, CONCURRENT_UPDATE
      • Message: Details about the operation
      • Params: Output parameter 'UpdatedFields' contains the fields that were actually changed

    • Executes the action with the provided parameters.

      Parameters

      Returns Promise<ActionResultSimple>

      Promise resolving to the action result

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods