uStoreProvider api activities - XMPieLab/uStore-NG GitHub Wiki
-
getActivities(activitiesIDs) ⇒
Promise.<ActivityModelArray> -
Provides active tasks of the current user
- ActivityModel
-
Provides information about asynchronous activity.
-
ActivityModelArray :
Array.<ActivityModel> -
Collection of information about asynchronous activity.
Enum values present async activity status
Kind: global enum
Properties
| Name | Type | Default |
|---|---|---|
| InProgress | number |
1 |
| Completed | number |
2 |
| Failed | number |
3 |
| PartiallyFailed | number |
4 |
Enum values activity type
Kind: global enum
Properties
| Name | Type | Default |
|---|---|---|
| OrderItemDuplication | number |
1 |
| KitOrderItemDupliction | number |
2 |
| CartListDuplication | number |
3 |
| OrderItemReordering | number |
4 |
| KitOrderItemReordering | number |
5 |
| OrderReordering | number |
6 |
getActivities(activitiesIDs) ⇒ Promise.<ActivityModelArray>
Provides active tasks of the current user
Kind: global function
Returns: Promise.<ActivityModelArray> - Returns a collection of information about asynchronous activity.
| Param | Type | Description |
|---|---|---|
| activitiesIDs | Array.<GUID> |
Collection of globally unique identifier |
Provides information about asynchronous activity.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| ActivityID | GUID |
The unique ID of the activity |
| Status | ActivityStatus |
The status of the activity |
| Type | ActivityType |
Activity type |
| Name | string |
The name of the activity |
| Total | number |
The total number of sub-items of the activity |
| Progress | number |
Activity progress |
| Output | null |
The output of the activity |
ActivityModelArray : Array.<ActivityModel>
Collection of information about asynchronous activity.
Kind: global typedef