ApiBehaviorOptions.SuppressMapClientErrors Vlastnost

Definice

Obor názvů:

Microsoft.AspNetCore.Mvc

Sestavení:

Microsoft.AspNetCore.Mvc.Core.dll

Balíček:

Microsoft.AspNetCore.App.Ref v8.0.0

Zdroj:

ApiBehaviorOptions.cs

Získá nebo nastaví hodnotu, která určuje, zda kontrolery s ApiControllerAttribute transformací určitých chyb klienta.

Když false, filtr výsledků se přidá do akcí kontroleru rozhraní API, které transformují IClientErrorActionResult. V opačném případě je filtr potlačen.

Ve výchozím nastavení ClientErrorMapping se používá k mapování IClientErrorActionResult na ProblemDetails instanci (vrácená jako hodnota pro ObjectResult).

Pokud chcete přizpůsobit výstup filtru (například pro vrácení jiného typu chyby), zaregistrujte vlastní implementaci IClientErrorFactory v kolekci služeb.

public:
 property bool SuppressMapClientErrors { bool get(); void set(bool value); };

public bool SuppressMapClientErrors { get; set; }

member this.SuppressMapClientErrors : bool with get, set

Public Property SuppressMapClientErrors As Boolean

Hodnota vlastnosti

Boolean

Výchozí hodnota je false.

Poznámky

Tato vlastnost je přidružena k přepínači kompatibility a může poskytovat odlišné chování v závislosti na nakonfigurované verzi kompatibility pro aplikaci. Pokyny a příklady nastavení verze kompatibility aplikace najdete v tématu CompatibilityVersion .

Konfigurace požadované hodnoty přepínače kompatibility voláním setter této vlastnosti bude mít přednost před hodnotou odvozenou z objektu aplikace CompatibilityVersion.

Pokud je verze kompatibility aplikace nastavená na Version_2_1 nebo nižší, bude mít toto nastavení hodnotu false , pokud není explicitně nakonfigurováno.

Pokud je verze kompatibility aplikace nastavená na Version_2_2 nebo vyšší, bude mít toto nastavení hodnotu true , pokud není explicitně nakonfigurováno.