refreshHitListObjects()

Refresh the given objects in open hit lists. One of the seven portable facade methods of the Dashlet handle — see call for the string-based surface, which shares the same dispatch core.

1. Signature

refreshHitListObjects(ids: Array<string | number>): Promise<boolean | undefined>;

2. Parameters

Name Type Description

ids

Array of string or number

The object ids (osIds) to refresh in the open hit lists.

3. Per-environment behavior

Environment Behavior

webclient

The params slot is [ids] — the ids array as the single argument (live-verified raw wire: ["refreshHitListObjects", [["123","456"]], {msgId}]). A flat slot would dispatch each id as a separate argument, and the host answers false in that case. Correlated — resolves with the host’s boolean result.

rich client

One osjxRefreshObjectInLists(id) call per id, in order, and all are attempted (no fail-fast). If any bridge call threw, the promise rejects with one descriptive aggregation error naming the first failing id and the failed/total counts (refreshHitListObjects: osjxRefreshObjectInLists failed for id "…" (N of M refreshes failed): …); when every id succeeded, it resolves undefined.

standalone (or still detecting without a wire)

No host reply path exists — the call rejects (bounded) with the TimeoutError so callers can render a fallback instead of hanging.

4. Examples

const ok = await dashlet.refreshHitListObjects(['1024', '1025']);

5. Errors

  • TypeError — a non-array argument via call(): the normalization requires an array of object ids and rejects any other shape descriptively.

  • The aggregation Error — rich client only: at least one per-id bridge refresh failed; the message names the first failing id and the failed count out of the total.

  • Error('dashlet destroyed') — the dashlet was destroyed before the call.

  • TimeoutError — bounded no-reply in standalone, or a host that never answered within timeoutMs.

  • The host’s { error } payload — when the host reports a failure on the webclient method call.