- Source:
actions
Methods
(static) createActivity(activity) → {Promise.<(*|boolean|void)>}
Create an activity.
- Source:
Create an activity
Parameters:
| Name | Type | Description |
|---|---|---|
activity |
Object |
Returns:
- Type
- Promise.<(*|boolean|void)>
(static) deleteActivity(ID) → {Promise.<(*|boolean|void)>}
Delete an activity matching the supplied ID.
- Source:
Delete an activity matching the supplied ID
Parameters:
| Name | Type | Description |
|---|---|---|
ID |
Array.<string, boolean> | An array containing the ID of the activity and a boolean to determine whether or not to remove from the store also |
Returns:
- Type
- Promise.<(*|boolean|void)>
(static) getActivities(search)
Retrieve an array of activities based on a provided query object.
- Source:
Retrieve an array of activities based on a provided query object
Parameters:
| Name | Type | Description |
|---|---|---|
search |
Array.<Object, number> | An array containing the search object and the limit for the number of results to return |
(static) getActivity(ID) → {Promise.<(*|boolean|void)>}
Retrieve a single activity based on the ID.
- Source:
Retrieve a single activity based on the ID
Parameters:
| Name | Type | Description |
|---|---|---|
ID |
Array.<string, boolean> | An array containing the ID of the activity and a boolean to determine whether or not to retrieve the media and comments also |
Returns:
- Type
- Promise.<(*|boolean|void)>
(static) getActivityCount(search)
Returns a count for the number of activities matching criteria.
- Source:
Returns a count for the number of activities matching criteria
Parameters:
| Name | Type | Description |
|---|---|---|
search |
Object | Search object the same as one would use in getActivities |