Item class

container: Container

Eigenschaftswert

id: string

Eigenschaftswert

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

string url

Eigenschaftswert

Das Element löschen.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

Gibt zurück

Führen Sie ein JSONPatch für das Element aus.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

function patch<T>(body: PatchRequestBody, options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

Gibt zurück

Lesen Sie die Definition des Elements.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen. Wenn der Typ "T" eine Klasse ist, werden typeof Vergleiche nicht übergeben, da er keinen Übereinstimmungsprototyp aufweist. Es wird empfohlen, nur Schnittstellen zu verwenden.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

Beispiel

Verwenden eines benutzerdefinierten Typs für die Antwort

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());

function read<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

Gibt zurück

Ersetzen Sie die Definition des Elements.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

function replace(body: ItemDefinition, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parameter

Gibt zurück

Ersetzen Sie die Definition des Elements.

Jeder bereitgestellte Typ T wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein Festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl von benutzerdefinierten Eigenschaften enthalten.

function replace<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

Gibt zurück