Class DeleteObjectAction

Action for deleting a file object from a storage provider.

Example

await runAction({
  ActionName: 'Delete Storage Object',
  Params: [{
    Name: 'StorageAccount',
    Value: 'SharePoint Storage'
  }, {
    Name: 'ObjectName',
    Value: 'old-files/deprecated.doc'
  }]
});

Hierarchy (View Summary)

BaseFileStorageAction
- DeleteObjectAction

Index

Constructors

constructor

Methods

addOutputParam createErrorResult createSuccessResult getBooleanParam getDriverFromParams getNumericParam getParamValue getStorageAccount getStorageProviderById getStringParam getStringParamWithDefault initializeDriver InternalRunAction Run

Constructors

constructor

new DeleteObjectAction(): DeleteObjectAction
Returns DeleteObjectAction
Inherited from BaseFileStorageAction.constructor

Methods

`Protected`addOutputParam

addOutputParam(params: RunActionParams, name: string, value: unknown): void
Helper to add output parameter
Parameters
- params: RunActionParams
- name: string
- value: unknown
Returns void
Inherited from BaseFileStorageAction.addOutputParam
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:84

`Protected`createErrorResult

createErrorResult(message: string, code: string): ActionResultSimple
Helper to create error result
Parameters
- message: string
- code: string
Returns ActionResultSimple
Inherited from BaseFileStorageAction.createErrorResult
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:107

`Protected`createSuccessResult

createSuccessResult(
data: Record<string, unknown>,
params?: RunActionParams,
): ActionResultSimple
Helper to create success result
Parameters
- data: Record<string, unknown>
- Optionalparams: RunActionParams
Returns ActionResultSimple
Inherited from BaseFileStorageAction.createSuccessResult
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:95

`Protected`getBooleanParam

getBooleanParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: boolean,
): boolean
Get boolean parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: boolean = false
Returns boolean
Inherited from BaseFileStorageAction.getBooleanParam
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:142

`Protected`getDriverFromParams

getDriverFromParams(
params: RunActionParams,
): Promise<{ driver?: FileStorageBase; error?: ActionResultSimple }>
Get storage account and initialize driver in one step using enterprise model
Parameters
- params: RunActionParams
  Action parameters containing StorageAccount
Returns Promise<{ driver?: FileStorageBase; error?: ActionResultSimple }>
Initialized driver and result if error occurred
Inherited from BaseFileStorageAction.getDriverFromParams
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:54

`Protected`getNumericParam

getNumericParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: number,
): number
Get numeric parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: number = 0
Returns number
Inherited from BaseFileStorageAction.getNumericParam
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:151

`Protected`getParamValue

getParamValue(params: RunActionParams, paramName: string): string
Extract parameter value by name (case-insensitive)
Parameters
- params: RunActionParams
- paramName: string
Returns string
Inherited from BaseFileStorageAction.getParamValue
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:118

`Protected`getStorageAccount

getStorageAccount(accountName: string): MJFileStorageAccountEntity
Get storage account entity by name using cached metadata.
Parameters
- accountName: string
  Name of the storage account
Returns MJFileStorageAccountEntity
MJFileStorageAccountEntity or null if not found
Inherited from BaseFileStorageAction.getStorageAccount
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:22

`Protected`getStorageProviderById

getStorageProviderById(providerId: string): MJFileStorageProviderEntity
Get storage provider entity by ID using cached metadata.
Parameters
- providerId: string
  ID of the storage provider
Returns MJFileStorageProviderEntity
MJFileStorageProviderEntity or null if not found
Inherited from BaseFileStorageAction.getStorageProviderById
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:31

`Protected`getStringParam

getStringParam(params: RunActionParams, paramName: string): string
Get string parameter value (guaranteed to be string or undefined)
Parameters
- params: RunActionParams
- paramName: string
Returns string
Inherited from BaseFileStorageAction.getStringParam
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:126

`Protected`getStringParamWithDefault

getStringParamWithDefault(
    params: RunActionParams,
    paramName: string,
    defaultValue: string,
): string
Get string parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: string
Returns string
Inherited from BaseFileStorageAction.getStringParamWithDefault
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:135

`Protected`initializeDriver

initializeDriver(
accountEntity: MJFileStorageAccountEntity,
contextUser: UserInfo,
): Promise<FileStorageBase>
Initialize storage driver using the enterprise credential model via FileStorageEngine.
Parameters
- accountEntity: MJFileStorageAccountEntity
  MJFileStorageAccountEntity to initialize
- contextUser: UserInfo
  User context for credential access
Returns Promise<FileStorageBase>
Initialized FileStorageBase driver
Inherited from BaseFileStorageAction.initializeDriver
- Defined in Actions/CoreActions/src/custom/files/base-file-storage.action.ts:41

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Delete a file object
Parameters
- params: RunActionParams
  The action parameters:
  
  StorageAccount: Required - Name of the storage provider
  
  ObjectName: Required - Name/path of the object to delete
Returns Promise<ActionResultSimple>
Operation result with:
- Success: Boolean indicating if the delete succeeded
Overrides BaseFileStorageAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/files/delete-object.action.ts:36

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseFileStorageAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37

Class DeleteObjectAction

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns DeleteObjectAction

Methods

ProtectedaddOutputParam

Parameters

Returns void

ProtectedcreateErrorResult

Parameters

Returns ActionResultSimple

ProtectedcreateSuccessResult

Parameters

Returns ActionResultSimple

ProtectedgetBooleanParam

Parameters

Returns boolean

ProtectedgetDriverFromParams

Parameters

Returns Promise<{ driver?: FileStorageBase; error?: ActionResultSimple }>

ProtectedgetNumericParam

Parameters

Returns number

ProtectedgetParamValue

Parameters

Returns string

ProtectedgetStorageAccount

Parameters

Returns MJFileStorageAccountEntity

ProtectedgetStorageProviderById

Parameters

Returns MJFileStorageProviderEntity

ProtectedgetStringParam

Parameters

Returns string

ProtectedgetStringParamWithDefault

Parameters

Returns string

ProtectedinitializeDriver

Parameters

Returns Promise<FileStorageBase>

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Settings

On This Page

`Protected`addOutputParam

`Protected`createErrorResult

`Protected`createSuccessResult

`Protected`getBooleanParam

`Protected`getDriverFromParams

`Protected`getNumericParam

`Protected`getParamValue

`Protected`getStorageAccount

`Protected`getStorageProviderById

`Protected`getStringParam

`Protected`getStringParamWithDefault

`Protected`initializeDriver

`Protected`InternalRunAction