IDownstreamApi.CallApiForUserAsync Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Przeciążenia
| Nazwisko | Opis |
|---|---|
| CallApiForUserAsync(String, Action<DownstreamApiOptions>, ClaimsPrincipal, HttpContent, CancellationToken) |
Wywołuje podrzędny interfejs API w imieniu użytkownika, na podstawie opisu podrzędnego interfejsu API w konfiguracji (nazwie usługi), przesłaniaj programowo. Jest to interfejs API niższego poziomu. Istnieją inne interfejsy API dla określonych metod Http. |
| CallApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Wywołuje podrzędny interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane. |
| CallApiForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Wywołuje podrzędny interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane. |
| CallApiForUserAsync<TOutput>(String, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Wywoływanie internetowego punktu końcowego interfejsu API za pomocą modułu HttpGet i zwracanie silnie typiowanych danych. |
| CallApiForUserAsync<TOutput>(String, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Wywoływanie internetowego punktu końcowego interfejsu API za pomocą modułu HttpGet i zwracanie silnie typiowanych danych. |
CallApiForUserAsync(String, Action<DownstreamApiOptions>, ClaimsPrincipal, HttpContent, CancellationToken)
Wywołuje podrzędny interfejs API w imieniu użytkownika, na podstawie opisu podrzędnego interfejsu API w konfiguracji (nazwie usługi), przesłaniaj programowo. Jest to interfejs API niższego poziomu. Istnieją inne interfejsy API dla określonych metod Http.
public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallApiForUserAsync(string? serviceName, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Net.Http.HttpContent? content = default, System.Threading.CancellationToken cancellationToken = default);abstract member CallApiForUserAsync : string * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.HttpContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public Function CallApiForUserAsync (serviceName As String, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional content As HttpContent = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpResponseMessage)Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny internetowy interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
(Opcjonalnie) Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
(Opcjonalnie) Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z kontekstu żądania HTTP.
- content
- HttpContent
Zawartość do wysłania do interfejsu API w przypadku, gdy HttpMethod to HttpMethod.Patch, , PostPut.
- cancellationToken
- CancellationToken
Token anulowania.
Zwraca
Element HttpResponseMessage , który aplikacja będzie przetwarzać.
Dotyczy
CallApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Wywołuje podrzędny interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TInput,TOutput>(string? serviceName, TInput input, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * 'Input * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Parametry typu
- TInput
Typ danych wejściowych.
- TOutput
Typ wyjścia.
Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.
- input
- TInput
Parametr wejściowy do podrzędnego internetowego interfejsu API.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
- cancellationToken
- CancellationToken
Token anulowania.
Zwraca
Wartość zwrócona przez podrzędny internetowy interfejs API.
Przykłady
Metoda listy zwracająca element IEnumerable<MyItem>>.
public Task<IEnumerable<MyItem>> GetAsync()
{
return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
ServiceName,
null,
options =>
{
options.RelativePath = $"api/todolist";
});
}
Przykład edytowania.
public Task<MyItem> EditAsync(MyItem myItem)
{
return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
ServiceName,
nyItem,
options =>
{
options.HttpMethod = HttpMethod.Patch;
options.RelativePath = $"api/todolist/{myItem.Id}";
});
}
Dotyczy
CallApiForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Wywołuje podrzędny interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TInput,TOutput>(string? serviceName, TInput input, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TInput> inputJsonTypeInfo, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TOutput> outputJsonTypeInfo, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * 'Input * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Input> * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Output (requires 'Output : null)> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, inputJsonTypeInfo As JsonTypeInfo(Of TInput), outputJsonTypeInfo As JsonTypeInfo(Of TOutput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Parametry typu
- TInput
Typ danych wejściowych.
- TOutput
Typ wyjścia.
Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.
- input
- TInput
Parametr wejściowy do podrzędnego internetowego interfejsu API.
- inputJsonTypeInfo
- JsonTypeInfo<TInput>
Metadane serializacji JSON dla funkcji TInput
- outputJsonTypeInfo
- JsonTypeInfo<TOutput>
Metadane serializacji JSON dla funkcji TOutput
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
- cancellationToken
- CancellationToken
Token anulowania.
Zwraca
Wartość zwrócona przez podrzędny internetowy interfejs API.
Przykłady
Metoda listy zwracająca element IEnumerable<MyItem>>.
public Task<IEnumerable<MyItem>> GetAsync()
{
return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
ServiceName,
null,
options =>
{
options.RelativePath = $"api/todolist";
});
}
Przykład edytowania.
public Task<MyItem> EditAsync(MyItem myItem)
{
return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
ServiceName,
nyItem,
options =>
{
options.HttpMethod = HttpMethod.Patch;
options.RelativePath = $"api/todolist/{myItem.Id}";
});
}
Dotyczy
CallApiForUserAsync<TOutput>(String, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Wywoływanie internetowego punktu końcowego interfejsu API za pomocą modułu HttpGet i zwracanie silnie typiowanych danych.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TOutput>(string serviceName, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TOutput As Class) (serviceName As String, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Parametry typu
- TOutput
Typ wyjścia.
Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
- cancellationToken
- CancellationToken
Token anulowania.
Zwraca
Wartość zwrócona przez podrzędny internetowy interfejs API.
Dotyczy
CallApiForUserAsync<TOutput>(String, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Wywoływanie internetowego punktu końcowego interfejsu API za pomocą modułu HttpGet i zwracanie silnie typiowanych danych.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TOutput>(string serviceName, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TOutput> outputJsonTypeInfo, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Output (requires 'Output : null)> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TOutput As Class) (serviceName As String, outputJsonTypeInfo As JsonTypeInfo(Of TOutput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Parametry typu
- TOutput
Typ wyjścia.
Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.
- outputJsonTypeInfo
- JsonTypeInfo<TOutput>
Metadane serializacji JSON dla funkcji TOutput
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
- cancellationToken
- CancellationToken
Token anulowania.
Zwraca
Wartość zwrócona przez podrzędny internetowy interfejs API.