Item class
Wordt gebruikt voor het uitvoeren van bewerkingen op een specifiek item.
Zie Items voor bewerkingen op alle items; zie container.items
.
container | |
id | |
url | Retourneert een verwijzings-URL naar de resource. Wordt gebruikt voor het koppelen in Machtigingen. |
delete<T>(Request |
Verwijder het item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen. |
patch<T>(Patch |
Voer een JSONPatch uit op het item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen. |
read<T>(Request |
Lees de definitie van het item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK.
Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen.
Als het type T een klasse is, slaagt het niet voor Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. Voorbeeld Aangepast type voor antwoord gebruiken
|
replace(Item |
Vervang de definitie van het item. Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. |
replace<T>(T, Request |
Vervang de definitie van het item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen. Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. |
id: string
Waarde van eigenschap
string
Retourneert een verwijzings-URL naar de resource. Wordt gebruikt voor het koppelen in Machtigingen.
string url
Waarde van eigenschap
string
Verwijder het item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen.
function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>
Parameters
- options
- RequestOptions
Aanvullende opties voor de aanvraag
Retouren
Promise<ItemResponse<T>>
Voer een JSONPatch uit op het item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen.
function patch<T>(body: PatchRequestBody, options?: RequestOptions): Promise<ItemResponse<T>>
Parameters
- body
- PatchRequestBody
- options
- RequestOptions
Aanvullende opties voor de aanvraag
Retouren
Promise<ItemResponse<T>>
Lees de definitie van het item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK.
Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen.
Als het type T een klasse is, slaagt het niet voor typeof
vergelijkingen, omdat het geen overeenkomende prototype heeft.
Het wordt aanbevolen om alleen interfaces te gebruiken.
Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
Voorbeeld
Aangepast type voor antwoord gebruiken
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>>
Parameters
- options
- RequestOptions
Aanvullende opties voor de aanvraag
Retouren
Promise<ItemResponse<T>>
Vervang de definitie van het item.
Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
function replace(body: ItemDefinition, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>
Parameters
- body
- ItemDefinition
De definitie om de definitie van het bestaande item door te vervangen.
- options
- RequestOptions
Aanvullende opties voor de aanvraag
Retouren
Promise<ItemResponse<ItemDefinition>>
Vervang de definitie van het item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om dit af te dwingen.
Er is geen vast schema voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
function replace<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
Parameters
- body
-
T
De definitie om de definitie van het bestaande item door te vervangen.
- options
- RequestOptions
Aanvullende opties voor de aanvraag
Retouren
Promise<ItemResponse<T>>