openHitListByIds()

Öffnet eine gemischte Trefferliste mit den angegebenen Objekten. Eine der sieben portablen Fassade-Methoden des Dashlet-Handles — siehe call für die zeichenkettenbasierte Oberfläche, die denselben Dispatch-Kern teilt.

1. Signatur

openHitListByIds(options: OpenHitListByIdsOptions): Promise<void>;

2. Parameter

Name Typ Beschreibung

objects

Array von { objectId, objectTypeId }

Die in der Trefferliste anzuzeigenden Objekte.

inNewTab

boolean (optional)

In einem neuen Tab öffnen (nur Webclient). true macht den Aufruf abwartend (korrelierter Post); false oder weggelassen macht ihn fire-and-forget (siehe unten).

title

string (optional)

Titel der Trefferliste. Der Rich Client verlangt einen nicht-leeren Titel — ein leerer/weggelassener Titel wird mit dem festen Standard 'Result list' ersetzt.

description

string (optional)

Untertitel der Trefferliste (nur Webclient; das Bridge hat kein Äquivalent).

executeSingleHitAction

boolean (optional)

Führt die Standardaktion des einzelnen Treffers aus (nur Webclient; die Bridge hat kein Äquivalent).

3. Verhalten pro Umgebung

Umgebung Verhalten

webclient

Der Params-Slot ist ein Objekt { objects, inNewTab, title, description, executeSingleHitAction } (im Gegensatz zu den plain-Arrays der anderen Methoden). Fire-and-forget- Regel: inNewTab !== true postet OHNE msgId und löst sich sofort auf — die Änderung der Ansicht kann das Dashlet-iFrame vernichten, bevor eine Antwort eintrifft, sodass ein korrelierter Post nur noch sinnlos ausliefe. Client-seitige Fehler bei fire-and-forget-Posts werden nicht gemeldet (dokumentiertes Host-Quirk). inNewTab === true wird korreliert abgewartet.

rich client

osjxOpenResultList(<single JSON string>) — genau ein Argument, eine JSON- Zeichenkette der Form { title, hits: [{ id, type }] } mit Zeichenketten-id/type. Ein leerer/weggelassener title wird mit dem festen Standard 'Result list' ersetzt (die Bridge verlangt nicht-leer). inNewTab, description und executeSingleHitAction haben kein Bridge-Äquivalent und werden nicht gesendet. Löst sich undefined auf.

standalone (oder noch im Erkennungsmodus ohne Wire)

Es gibt keinen Host-Antwortsweg — der Aufruf wird (begrenzt) mit dem TimeoutError abgelehnt, damit Aufrufer einen Fallback darstellen können, statt aufzuhängen.

4. Beispiele

await dashlet.openHitListByIds({
    objects: [{ objectId: '1024', objectTypeId: 262145 }],
    inNewTab: true,
    title: 'Offene Dokumente',
});

5. Fehler

  • TypeError — ein fehlerhaftes Options-Objekt: die Optionen müssen ein plain-Objekt mit einem objects-Array sein (die Normalisierung lehnt jede andere Form beschreibend ab).

  • Error('dashlet destroyed') — das Dashlet wurde vor dem Aufruf zerstört.

  • TimeoutError — begrenztes Fehlen einer Antwort im Standalone, oder ein korrelierter (inNewTab === true) Webclient-Post, dessen Host innerhalb von timeoutMs nie geantwortet hat. Fire-and-forget-Posts lösen sich sofort auf (kein Timeout möglich).

  • Das Host-{ error }-Payload — wenn der Host einen Fehler bei einem Webclient-Methodenaufruf meldet.