refreshObjectInLists(objectId)

Refreshes the object in open hit lists in the rich client. One of the rich-client handle methods, obtained via getRichClientApi() — unlike the portable facade refreshHitListObjects, this is a direct, synchronous bridge write: no dispatch core, no validation, the raw number straight to the bridge.

1. Signature

refreshObjectInLists(objectId: number): void;

2. Parameters

Name Type Description

objectId

number

The object id (osid) — passed unmodified to the bridge.

3. Behavior

  • Synchronous: the bridge is a synchronous COM/JS call — refreshObjectInLists(objectId) invokes osjxRefreshObjectInLists(objectId) immediately and returns void; there is no promise to await.

  • Direct bridge write: the raw objectId number goes straight to the bridge member osjxRefreshObjectInLists — unvalidated and unnormalized.

  • Throw-safe: a missing bridge member (incl. a reduced bridge at call time) throws the descriptive TypeError; a bridge call that throws is converted into the descriptive Error — never an uncaught host-proxy throw, on any client version (see Errors).

  • Lazy per-call read: the handle reads window.osClient per call (no creation-time snapshot) — a bridge state that is injected or swapped later is reflected immediately.

Contrast with the facade. The handle refreshes exactly one object per call. The facade refreshHitListObjects(ids) instead iterates over every id in order, attempts all of them (no fail-fast), and then — if any bridge call threw — rejects with a single descriptive aggregation error naming the first failing id (refreshHitListObjects: osjxRefreshObjectInLists failed for id "…" (N of M refreshes failed): …).

4. Examples

rich.refreshObjectInLists(1024);

5. Errors

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

  • TypeError: Dashlet.getRichClientApi(): the environment is not resolved yet - await the dashlet.init promise first — the handle was requested before the environment was resolved (accessor error).

  • TypeError: Dashlet.getRichClientApi(): the rich client API handle is only available in the richClient environment (current: …) — the handle was requested in the wrong environment (accessor error; the current value is named).

  • TypeError: Dashlet: the rich-client bridge does not expose "osjxRefreshObjectInLists" (bridge method missing) — the bridge member is missing (e.g. a reduced bridge at call time).

  • Error: Dashlet: rich-client bridge call "osjxRefreshObjectInLists" failed: … — the bridge call itself threw (the detail names the bridge error).