openResultList(json)

Opens the result list (hit list) in the rich client from a raw JSON string. One of the rich-client handle methods, obtained via getRichClientApi() — unlike the portable facade openHitListByIds (the facade equivalent), this is a direct, synchronous bridge write: no dispatch core, no validation, no normalization — the JSON string goes straight to the bridge unmodified.

1. Signature

openResultList(json: string): void;

2. Parameters

Name Type Description

json

string

The raw JSON string of the hit list, e.g. {"title":"…","hits":[{"id":"…","type":"…"}]} — passed unmodified to the bridge as its single argument. Documented form: exactly one argument (the JSON string). The legacy two-parameter (title, json) form is rejected by modern clients (error code 0x8002000E on v11.10+/v12.0) — the facade openHitListByIds posts the single-JSON-string form as well.

3. Behavior

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

  • Single argument: exactly one argument — the JSON string — goes to the bridge member osjxOpenResultList; the bridge yields void.

  • 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).

  • No normalization: the handle does no validation or normalization — the caller provides the JSON string itself. The facade openHitListByIds (the facade equivalent) builds it instead: a single JSON string of shape { title, hits: [{ id, type }] } with string id/type forms and a non-empty title (an empty/omitted title is substituted with the fixed default 'Result list').

  • 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.

4. Examples

rich.openResultList(JSON.stringify({ title: 'Suite hits', hits: [{ id: '1024', type: '262145' }] }));

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 "osjxOpenResultList" (bridge method missing) — the bridge member is missing (e.g. a reduced bridge at call time).

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