Partager via


ODataPreferenceHeader Classe

Définition

Classe pour définir l’en-tête « Prefer » sur un IODataRequestMessage ou l’en-tête « Preference-Applied » sur un IODataResponseMessage.

public class ODataPreferenceHeader
type ODataPreferenceHeader = class
Public Class ODataPreferenceHeader
Héritage
ODataPreferenceHeader

Propriétés

AnnotationFilter

Propriété pour obtenir et définir la préférence « odata.include-annotations » avec le filtre donné pour l'en-tête « Prefer » sur le IODataRequestMessage sous-jacent ou l'en-tête « Preference-Applied » sur le IODataResponseMessage sous-jacent. Si la préférence « odata-annotations » est déjà sur l'en-tête, remplace l'instance existante. Si la valeur null est retournée, la préférence « odata.include-annotations » n'est pas sur l'en-tête.

La chaîne de filtre peut être une liste délimitée par des virgules de l’un des modèles pris en charge suivants : « » -- Correspond à tous les noms d’annotation. » ns. » -- Correspond à tous les noms d’annotation sous l’espace de noms « ns ». « ns.name » -- Correspond uniquement au nom d'annotation « ns.name ». « - » -- L’opérateur exclude peut être utilisé avec n’importe quel modèle pris en charge, par exemple : « -ns. « -- Exclut tous les noms d’annotation sous l’espace de noms « ns ». -ns.name » -- Exclut uniquement le nom d’annotation « ns.name ». Le filtre Null ou vide équivaut à « - ».

La priorité relative du modèle dépend de la spécificité relative des modèles comparés. Si pattern1 est dans l'espace de noms pattern2, pattern1 est plus spécifique que pattern2 car il correspond à un sous-ensemble par rapport à pattern2. Les modèles plus spécifiques ont une priorité plus élevée. Par exemple : « ns. « a une priorité plus élevée que «  » « ns.name » a une priorité supérieure à « ns. « ns1.name » a la même priorité que « ns2 ».

Les modèles avec l’opérateur d’exclusion ont une priorité plus élevée que le même modèle sans. Par exemple, « -ns.name » a une priorité plus élevée que « ns.name ».

Exemples : « ns1. ,ns.name » -- Correspond à n’importe quel nom d’annotation sous l’espace de noms « ns1 » et l’annotation « ns.name ». « ,-ns.*,ns.name » -- Correspond à n’importe quel nom d’annotation en dehors de l’espace de noms « ns » et uniquement « ns.name » sous l’espace de noms « ns ».

ContinueOnError

Propriété permettant d’obtenir et de définir la préférence « odata.continue-on-error » sur l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou l’en-tête « Preference-Applied » sur l’ioDataResponseMessage sous-jacent. La définition de true définit la préférence « odata.continue-on-error ». La définition de false efface la préférence « odata.continue-on-error ». Retourne true de la préférence « odata.continue-on-error » sur l’en-tête. Sinon, retourne false si « odata.continue-on-error » n’est pas sur l’en-tête.

MaxPageSize

Propriété permettant d’obtenir et de définir la préférence « odata.maxpagesize » sur l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou « Preference-Applied » sur l’en-tête IODataResponseMessage sous-jacent. Le paramètre N définit la préférence « odata.maxpagesize=N ». La définition de null efface la préférence « odata.maxpagesize ». Renvoie N si la préférence « odata.maxpagesize=N » se trouve sur l’en-tête. Le retour de la valeur Null indique que « odata.maxpagesize » n’est pas sur l’en-tête.

RespondAsync

Propriété permettant d’obtenir et de définir la préférence « respond-async » sur l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou « Preference-Applied » sur l’en-tête IODataResponseMessage sous-jacent. La définition de true définit la préférence « respond-async ». La définition de false efface la préférence « respond-async ». Retourne true si la préférence « respond-async » se trouve sur l’en-tête. Sinon, retourne false si l’élément « respond-async » n’est pas sur l’en-tête.

ReturnContent

Propriété permettant d’obtenir et de définir les préférences « return=representation » et « return=minimal » sur l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou « Preference-Applied » sur l’ioDataResponseMessage sous-jacent. La définition de true définit la préférence « return=representation » et efface la préférence « return=minimal ». La définition de false définit la préférence « return=minimal » et efface la préférence « return=representation ». La définition de null efface les préférences « return=representation » et « return=minimal ». Retourne true si la préférence « return=representation » se trouve sur l’en-tête. Sinon, retourne false si la valeur « return=minimal » se trouve sur l’en-tête. Le retour de la valeur Null indique que « return=representation » et « return=minimal » ne figurent pas sur l’en-tête.

TrackChanges

Propriété permettant d’obtenir et de définir la préférence « odata.track-changes » sur l’en-tête « Prefer » sur l’ioDataRequestMessage sous-jacent ou l’en-tête « Preference-Applied » sur l’ioDataResponseMessage sous-jacent. La définition de true définit la préférence « odata.track-changes ». La définition de false efface la préférence « odata.track-changes ». Retourne true de la préférence « odata.track-changes » sur l’en-tête. Sinon, retourne false si « odata.track-changes » n’est pas sur l’en-tête.

Wait

Propriété permettant d’obtenir et de définir la préférence « wait » sur l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou « Preference-Applied » sur l’en-tête IODataResponseMessage sous-jacent. Le paramètre N définit la préférence « wait=N ». La définition de null efface la préférence « attendre ». Retourne N si la préférence « wait=N » se trouve sur l’en-tête. Le retour de la valeur Null indique que « wait » n’est pas sur l’en-tête.

Méthodes

Clear(String)

Efface le preference de l’en-tête « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou de l’en-tête « Preference-Applied » sur l’ioDataResponseMessage sous-jacent.

Get(String)

Obtient le preferenceName à partir de l’en-tête « Prefer » de l’en-tête sous-jacent IODataRequestMessage ou de l’en-tête « Preference-Applied » de l’en-tête sous-jacent IODataResponseMessage.

Set(HttpHeaderValueElement)

Définit l’en-tête preference « Prefer » sur l’en-tête IODataRequestMessage sous-jacent ou l’en-tête « Preference-Applied » sur l’en-tête IODataResponseMessage sous-jacent.

S’applique à