Interface BulkAction<T>

Type parameters

T: BulkActionPayload = any

Hierarchy

BulkActionProps<T>
BulkActionApiMethods
DefaultElements<BulkActionProps<T>>
- BulkAction

Index

Properties

Methods

Properties

action

action: BulkActionType

Optional error

error?: BulkActionFailedError

error information, if present

payload

payload: T

original payload when BulkAction was created

sys

sys: BulkActionSysProps

Methods

get

get(): BulkAction<any>

Inherited from BulkActionApiMethods.get
- Defined in entities/bulk-action.ts:94
Performs a new GET request and returns the wrapper BulkAction

Returns BulkAction<any>

toPlainObject

toPlainObject(): BulkActionProps<T>

Inherited from DefaultElements.toPlainObject
- Defined in common-types.ts:118
Returns BulkActionProps<T>

waitProcessing

waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction<any>>

Inherited from BulkActionApiMethods.waitProcessing
- Defined in entities/bulk-action.ts:96
Waits until the BulkAction is in one of the final states (succeeded or failed) and returns it.

Parameters
- Optional options: AsyncActionProcessingOptions
Returns Promise<BulkAction<any>>