Member Junction
    Preparing search index...

    Class DeleteRecordAction

    Generic action for deleting entity records from the database. This action provides a flexible way to delete records for any entity type by accepting the entity name and primary key values as parameters.

    // Delete a single record by ID
    await runAction({
      ActionName: 'Delete Record',
      Params: [
        {
          Name: 'EntityName',
          Value: 'Customers'
        },
        {
          Name: 'PrimaryKey',
          Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
        }
      ]
    });

    // Delete a record with composite primary key
    await runAction({
      ActionName: 'Delete Record',
      Params: [
        {
          Name: 'EntityName',
          Value: 'UserRoles'
        },
        {
          Name: 'PrimaryKey',
          Value: { 
            UserID: '123e4567-e89b-12d3-a456-426614174000',
            RoleID: '987f6543-e21b-12d3-a456-426614174000'
          }
        }
      ]
    });

    Hierarchy

    • BaseRecordMutationAction
      • DeleteRecordAction
    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    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.

    Methods

    • Deletes a record for the specified entity type using its primary key.

      Parameters

      • params: RunActionParams

        The action parameters containing:

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

      Returns Promise<ActionResultSimple>

      ActionResultSimple with:

      • Success: true if record was deleted successfully
      • ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED, CASCADE_CONSTRAINT, REFERENCE_CONSTRAINT
      • Message: Details about the operation
      • Params: Output parameter 'DeletedRecord' contains the data of the deleted record

    • 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
    Methods