Item class
Służy do wykonywania operacji na określonym elemencie.
Zobacz Items, aby uzyskać informacje o operacjach na wszystkich elementach; zobacz container.items
.
Właściwości
container | |
id | |
url | Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia. |
Metody
delete<T>(Request |
Usuń element. Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić. |
patch<T>(Patch |
Wykonaj element JSONPatch. Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić. |
read<T>(Request |
Przeczytaj definicję elementu. Każdy podany typ T nie musi być wymuszany przez zestaw SDK.
Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.
Jeśli typ T jest klasą, nie zostanie przekazany Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych. Przykład Używanie typu niestandardowego dla odpowiedzi
|
replace(Item |
Zastąp definicję elementu. Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych. |
replace<T>(T, Request |
Zastąp definicję elementu. Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić. Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych. |
Szczegóły właściwości
container
id
id: string
Wartość właściwości
string
url
Zwraca adres URL odwołania do zasobu. Służy do łączenia w obszarze Uprawnienia.
string url
Wartość właściwości
string
Szczegóły metody
delete<T>(RequestOptions)
Usuń element.
Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.
function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>
Parametry
- options
- RequestOptions
Dodatkowe opcje żądania
Zwraca
Promise<ItemResponse<T>>
patch<T>(PatchRequestBody, RequestOptions)
Wykonaj element JSONPatch.
Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.
function patch<T>(body: PatchRequestBody, options?: RequestOptions): Promise<ItemResponse<T>>
Parametry
- body
- PatchRequestBody
- options
- RequestOptions
Dodatkowe opcje żądania
Zwraca
Promise<ItemResponse<T>>
read<T>(RequestOptions)
Przeczytaj definicję elementu.
Każdy podany typ T nie musi być wymuszany przez zestaw SDK.
Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.
Jeśli typ T jest klasą, nie zostanie przekazany typeof
porównania, ponieważ nie będzie miał prototypu dopasowania.
Zaleca się używanie tylko interfejsów.
Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
Przykład
Używanie typu niestandardowego dla odpowiedzi
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>>
Parametry
- options
- RequestOptions
Dodatkowe opcje żądania
Zwraca
Promise<ItemResponse<T>>
replace(ItemDefinition, RequestOptions)
Zastąp definicję elementu.
Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
function replace(body: ItemDefinition, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>
Parametry
- body
- ItemDefinition
- options
- RequestOptions
Dodatkowe opcje żądania
Zwraca
Promise<ItemResponse<ItemDefinition>>
replace<T>(T, RequestOptions)
Zastąp definicję elementu.
Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.
Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
function replace<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
Parametry
- options
- RequestOptions
Dodatkowe opcje żądania
Zwraca
Promise<ItemResponse<T>>