Skip to content

RemoveActivity

type RemoveActivity = {
(activityId, opts?): Promise<void>;
(ref, opts?): Promise<RemovedActivities>;
};

Call-signature type for feed().removeActivity, kept as a named local type (rather than overload signatures on a function declaration) so the two forms keep their JSDoc in the emitted .d.ts — tsup’s dts step strips comments from inner-function overload declarations, but preserves them here.

(activityId, opts?): Promise<void>;

Soft-deletes one activity by dropin’s id. The gateway enforces authority = origin_feed, so a feed you don’t own is a 403.

Parameter Type
activityId string
opts? RequestOptions

Promise<void>

(ref, opts?): Promise<RemovedActivities>;

Removes every live activity in THIS feed with this foreign_id — with time, only that exact instant (pass activity.time from the add response). Resolves { removed: [] } when nothing matched, so a retry or a redelivered event is safe. The (foreign_id, time) identity stays burned: re-posting it is a 409 CONFLICT. The gateway enforces authority = origin_feed here too, so calling this on a feed you don’t own is a 403, not a silent no-op.

Parameter Type
ref ForeignIdRef
opts? RequestOptions

Promise<RemovedActivities>