Class GetObjectAction

Action for downloading file content from a storage provider.

Example

await runAction({
  ActionName: 'Get Storage Object',
  Params: [{
    Name: 'StorageProvider',
    Value: 'Google Cloud Storage'
  }, {
    Name: 'ObjectName',
    Value: 'data/export.json'
  }]
});

Hierarchy (view full)

BaseFileStorageAction
- GetObjectAction

Index

Constructors

constructor

Methods

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

Constructors

constructor

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

Methods

`Protected` InternalRunAction

InternalRunAction(params): Promise<ActionResultSimple>
Download file content from storage
Parameters
- params: RunActionParams<any>
  The action parameters:
  - StorageProvider: Required - Name of the storage provider
  - ObjectName: Required if ObjectID not provided - Name/path of the object
  - ObjectID: Optional - Provider-specific object ID (bypasses path resolution for faster access)
Returns Promise<ActionResultSimple>
Operation result with:
- Content: Base64-encoded file content
- Size: File size in bytes
Overrides BaseFileStorageAction.InternalRunAction
- Defined in CoreActions/src/custom/files/get-object.action.ts:38

Run

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

`Protected` addOutputParam

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

`Protected` createErrorResult

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

`Protected` createSuccessResult

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

`Protected` getBooleanParam

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

`Protected` getDriverFromParams

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

`Protected` getNumericParam

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

`Protected` getParamValue

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

`Protected` getStorageProvider

getStorageProvider(providerName, contextUser): Promise<FileStorageProviderEntity>
Get storage provider entity by name
Parameters
- providerName: string
  Name of the storage provider
- contextUser: UserInfo
  User context for the operation
Returns Promise<FileStorageProviderEntity>
FileStorageProviderEntity or null if not found
Inherited from BaseFileStorageAction.getStorageProvider
- Defined in CoreActions/src/custom/files/base-file-storage.action.ts:24

`Protected` getStringParam

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

`Protected` getStringParamWithDefault

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

`Protected` initializeDriver

initializeDriver(provider): Promise<FileStorageBase>
Initialize storage driver from provider entity
Parameters
- provider: FileStorageProviderEntity
  FileStorageProviderEntity to initialize
Returns Promise<FileStorageBase>
Initialized FileStorageBase driver
Inherited from BaseFileStorageAction.initializeDriver
- Defined in CoreActions/src/custom/files/base-file-storage.action.ts:44

Class GetObjectAction

Example

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Returns GetObjectAction

Methods

Protected InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Protected addOutputParam

Parameters

Returns void

Protected createErrorResult

Parameters

Returns ActionResultSimple

Protected createSuccessResult

Parameters

Returns ActionResultSimple

Protected getBooleanParam

Parameters

Returns boolean

Protected getDriverFromParams

Parameters

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

Protected getNumericParam

Parameters

Returns number

Protected getParamValue

Parameters

Returns string

Protected getStorageProvider

Parameters

Returns Promise<FileStorageProviderEntity>

Protected getStringParam

Parameters

Returns string

Protected getStringParamWithDefault

Parameters

Returns string

Protected initializeDriver

Parameters

Returns Promise<FileStorageBase>

Settings

Member Visibility

Theme

On This Page

`Protected` InternalRunAction

`Protected` addOutputParam

`Protected` createErrorResult

`Protected` createSuccessResult

`Protected` getBooleanParam

`Protected` getDriverFromParams

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

`Protected` getNumericParam

`Protected` getParamValue

`Protected` getStorageProvider

`Protected` getStringParam

`Protected` getStringParamWithDefault

`Protected` initializeDriver