useFeedActions
function useFeedActions<TCustom>(group, id): object;Write-only feed actions. Inside a disabled provider both functions are no-ops
resolving undefined (never rejecting) and enabled is false.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
TCustom |
Record<string, unknown> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
group |
string |
id |
string |
Returns
Section titled “Returns”object
addActivity
Section titled “addActivity”addActivity: (a) => Promise<Activity<TCustom> | undefined>;Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
a |
{ custom?: TCustom; object: string; refs?: string[]; verb: string; } |
- |
a.custom? |
TCustom |
- |
a.object |
string |
- |
a.refs? |
string[] |
Objects this activity points at, as type:id. Max 4. Resolved into the feed read’s objects sidecar — see useFeed. |
a.verb |
string |
- |
Returns
Section titled “Returns”Promise<Activity<TCustom> | undefined>
deleteActivity
Section titled “deleteActivity”deleteActivity: (activityId) => Promise<void | undefined>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
activityId |
string |
Returns
Section titled “Returns”Promise<void | undefined>
enabled
Section titled “enabled”enabled: boolean;