Partager via


Item class

Permet d’effectuer des opérations sur un élément spécifique.

Consultez éléments pour les opérations sur tous les éléments ; voir container.items.

Propriétés

container
id
url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

delete<T>(RequestOptions)

Supprimez l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

patch<T>(PatchRequestBody, RequestOptions)

Effectuez un JSONPatch sur l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

read<T>(RequestOptions)

Lisez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer. Si le type, T, est une classe, elle ne passe pas typeof comparaisons, car elle n’a pas de prototype de correspondance. Il est recommandé d’utiliser uniquement les interfaces.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

exemple de

Utilisation du type personnalisé pour la réponse

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

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

Remplacez la définition de l’élément.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

replace<T>(T, RequestOptions)

Remplacez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

Détails de la propriété

container

container: Container

Valeur de propriété

id

id: string

Valeur de propriété

string

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

delete<T>(RequestOptions)

Supprimez l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

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

Paramètres

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Effectuez un JSONPatch sur l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

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

Paramètres

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Lisez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer. Si le type, T, est une classe, elle ne passe pas typeof comparaisons, car elle n’a pas de prototype de correspondance. Il est recommandé d’utiliser uniquement les interfaces.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

exemple de

Utilisation du type personnalisé pour la réponse

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

Paramètres

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Remplacez la définition de l’élément.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body
ItemDefinition

Définition à utiliser pour remplacer la définition de l’élément existante.

options
RequestOptions

Options supplémentaires pour la demande

Retours

replace<T>(T, RequestOptions)

Remplacez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le Kit de développement logiciel (SDK). Vous pouvez obtenir plus ou moins de propriétés et il est à votre logique de l’appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Ils peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body

T

Définition à utiliser pour remplacer la définition de l’élément existante.

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>