Freigeben über

ODataPreferenceHeader Klasse

  • Referenz

Definition

Namespace:
Microsoft.OData
Assembly:
Microsoft.OData.Core.dll
Paket:
Microsoft.OData.Core v7.9.0

Klasse, um den Header "Prefer" für einen IODataRequestMessage oder den Header "Preference-Applied" auf einem IODataResponseMessagefestzulegen.

public class ODataPreferenceHeader
type ODataPreferenceHeader = class
Public Class ODataPreferenceHeader
Vererbung
Object
ODataPreferenceHeader

Eigenschaften

AnnotationFilter

Eine Eigenschaft, mit der die odata.include-annotations-Einstellung mit dem angegebenen Filter für den Prefer-Header der zugrunde liegenden IODataRequestMessage oder für den Preference-Applied-Header der zugrunde liegenden IODataResponseMessage abgerufen bzw. festgelegt wird. Wenn die odata-annotations-Einstellung bereits für den Header vorhanden ist, wird die vorhandene Instanz durch Set ersetzt. Wird NULL zurückgegeben, ist keine odata.include-annotations-Einstellung für den Header vorhanden.

Die Filterzeichenfolge kann eine durch Kommas getrennte Liste mit einem der folgenden unterstützten Muster sein: "" – Entspricht allen Anmerkungsnamen. " ns." – Entspricht allen Anmerkungsnamen unter dem Namespace "ns". "ns.name" – Entspricht nur dem Anmerkungsnamen "ns.name". "-" – Der exclude-Operator kann mit einem der unterstützten Muster verwendet werden, z. B. "-ns. " – Schließt alle Anmerkungsnamen unter dem Namespace "ns" aus. " -ns.name" – Schließt nur den Anmerkungsnamen "ns.name" aus. Null- oder leerer Filter entspricht "-".

Die relative Priorität des Musters basiert auf der relativen Detailgenauigkeit der verglichenen Muster. Wenn Muster1 unter dem Muster2-Namespace enthalten ist, ist Muster1 spezifischer als Muster2, weil Muster1 nur eine Teilmenge der Entsprechungen von Muster2 aufweist. Mustern, die spezifischer sind, wird eine höhere Priorität eingeräumt. Beispiel: "ns. " hat eine höhere Priorität als "" "ns.name" hat eine höhere Priorität als "ns". "ns1.name" hat dieselbe Priorität wie "ns2".

Muster mit dem Exclude-Operator haben eine höhere Priorität als dasselbe Muster ohne. Beispiel: "-ns.name" hat eine höhere Priorität als "ns.name".

Beispiele: "ns1. ,ns.name" – Entspricht jedem Anmerkungsnamen unter dem Namespace "ns1" und der Anmerkung "ns.name". ",-ns.*,ns.name" – Entspricht jedem Anmerkungsnamen außerhalb des "ns"-Namespace und nur "ns.name" unter dem Namespace "ns".
ContinueOnError

Eigenschaft zum Abrufen und Festlegen der Einstellung "odata.continue-on-error" auf den "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage. Durch Festlegen von true wird die Einstellung "odata.continue-on-error" festgelegt. Durch Festlegen von false wird die Einstellung "odata.continue-on-error" gelöscht. Gibt true zurück, wenn sich die Einstellung "odata.continue-on-error" im Header befindet. Andernfalls wird false zurückgegeben, wenn sich "odata.continue-on-error" nicht im Header befindet.
MaxPageSize

Eigenschaft zum Abrufen und Festlegen der Einstellung "odata.maxpagesize" auf den "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage. Durch Festlegen von N wird die Einstellung "odata.maxpagesize=N" festgelegt. Durch Festlegen von NULL wird die Einstellung "odata.maxpagesize" gelöscht. Gibt N zurück, wenn sich die Einstellung "odata.maxpagesize=N" im Header befindet. Das Zurückgeben von NULL gibt an, dass sich "odata.maxpagesize" nicht im Header befindet.
RespondAsync

Eigenschaft, um die Einstellung "respond-async" abzurufen und auf den Header "Prefer" für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage festzulegen. Durch Festlegen von true wird die Einstellung "respond-async" festgelegt. Durch Festlegen von false wird die Einstellung "respond-async" gelöscht. Gibt true zurück, wenn sich die Einstellung "respond-async" im Header befindet. Andernfalls wird false zurückgegeben, wenn sich "respond-async" nicht im Header befindet.
ReturnContent

Eigenschaft zum Abrufen und Festlegen der Einstellungen "return=representation" und "return=minimal" auf den "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage. Durch Festlegen von true wird die Einstellung "return=representation" festgelegt und die Einstellung "return=minimal" gelöscht. Durch Festlegen von false wird die Einstellung "return=minimal" festgelegt und die Einstellung "return=representation" gelöscht. Durch Festlegen von NULL werden die Einstellungen "return=representation" und "return=minimal" gelöscht. Gibt true zurück, wenn sich die Einstellung "return=representation" im Header befindet. Andernfalls wird false zurückgegeben, wenn sich "return=minimal" im Header befindet. Das Zurückgeben von NULL gibt an, dass sich "return=representation" und "return=minimal" nicht im Header befinden.
TrackChanges

Eigenschaft zum Abrufen und Festlegen der Einstellung "odata.track-changes" auf den Header "Prefer" für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage. Durch Festlegen von true wird die Einstellung "odata.track-changes" festgelegt. Durch festlegen von false wird die Einstellung "odata.track-changes" gelöscht. Gibt true zurück, wenn sich die Einstellung "odata.track-changes" im Header befindet. Andernfalls wird false zurückgegeben, wenn sich "odata.track-changes" nicht im Header befindet.
Wait

Eigenschaft zum Abrufen und Festlegen der Warteeinstellung auf den "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage. Durch festlegen von N wird die Einstellung "wait=N" festgelegt. Wenn Sie NULL festlegen, wird die Warteeinstellung gelöscht. Gibt N zurück, wenn sich die Einstellung "wait=N" im Header befindet. Das Zurückgeben von NULL gibt an, dass sich "wait" nicht im Header befindet.

Methoden

Clear(String)

Löscht den preference aus dem "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage.
Get(String)

Ruft den preferenceName aus dem "Prefer"-Header aus dem zugrunde liegenden IODataRequestMessage oder den Header "Preference-Applied" aus dem zugrunde liegenden IODataResponseMessageab.
Set(HttpHeaderValueElement)

Legt den preference auf den "Prefer"-Header für die zugrunde liegende IODataRequestMessage oder den Header "Preference-Applied" für die zugrunde liegende IODataResponseMessage fest.

Gilt für: