ODataPreferenceHeader Класс

Определение

Пространство имен:

Microsoft.OData

Сборка:

Microsoft.OData.Core.dll

Пакет:

Microsoft.OData.Core v7.9.0

Класс, задающий заголовок Prefer в или IODataRequestMessage заголовок IODataResponseMessagePreference-Applied в .

public class ODataPreferenceHeader

type ODataPreferenceHeader = class

Public Class ODataPreferenceHeader

Наследование

Object

ODataPreferenceHeader

Свойства

AnnotationFilter	Свойство для получения и задания параметра предпочтения «odata.include-annotations» с заданным фильтром в заголовке «Prefer» используемого IODataRequestMessage или заголовке «Preference-Applied» в IODataResponseMessage. Если параметр "odata-annotations" уже есть в заголовке, установка заменяет текущий экземпляр. Возвращащенное значение null, означает что параметра "odata-annotations" нет в заголовке. Строка фильтра может быть разделенным запятыми списком любого из следующих поддерживаемых шаблонов: "" - соответствует всем именам заметок. " ns. -- Соответствует всем именам заметок в пространстве имен "ns". «ns.name» — соответствие только имени ns.name. "-" - Оператор exclude можно использовать с любым поддерживаемым шаблоном, например "-ns". " -- Исключает все имена заметок в пространстве имен "ns". " -ns.name" — исключает только имя заметки "ns.name". Фильтр null или пустой эквивалентен "-". Относительный приоритет шаблона основан на относительной точности сравниваемых шаблонов. Если шаблон1 находится в пространстве имен шаблон2, шаблон1 более точный чем шаблон2, поскольку шаблон1 соответствует подмножеству того, чему соответствует шаблон2. Больший приоритет дается более точному шаблону. Например: "ns. " имеет более высокий приоритет, чем "" "ns.name" имеет более высокий приоритет, чем "ns. " "ns1.name" имеет тот же приоритет, что и "ns2". Шаблоны с оператором exclude имеют более высокий приоритет, чем тот же шаблон без. Например, «-ns.name» имеет более высокий приоритет, чем «ns.name». Примеры: "ns1. , ns.name" — соответствует любому имени заметки в пространстве имен "ns1" и "ns.name". ",-ns.*,ns.name" - соответствует любому имени заметки за пределами пространства имен "ns" и только "ns.name" в пространстве имен "ns".
ContinueOnError	Свойство для получения и задания параметра "odata.continue-on-error" в качестве заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Значение true задает параметр "odata.continue-on-error". Если задать значение false, параметр odata.continue-on-error будет снят. Возвращает значение true для параметра "odata.continue-on-error" в заголовке. В противном случае возвращает значение false, если значение "odata.continue-on-error" отсутствует в заголовке .
MaxPageSize	Свойство для получения и задания параметра "odata.maxpagesize" в качестве заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Параметр N задает параметр "odata.maxpagesize=N". Если задать значение NULL, параметр "odata.maxpagesize" будет снят. Возвращает N, если параметр "odata.maxpagesize=N" находится в заголовке. Возврат значения NULL означает, что "odata.maxpagesize" не находится в заголовке.
RespondAsync	Свойство для получения и задания предпочтения "respond-async" в качестве заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Если задать значение true, то параметр "ответить-асинхронный" параметр. Если задать значение false, то параметр "ответить-асинхронный" удаляется. Возвращает значение true, если параметр "respond-async" находится в заголовке . В противном случае возвращает значение false, если свойство "respond-async" не находится в заголовке .
ReturnContent	Свойство для получения и задания параметров "return=representation" и "return=minimal" для заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Если задать значение true, задается предпочтение "return=representation" и удаляется параметр "return=minimal". Установка значения false задает параметр "return=minimal" и удаляет параметр "return=representation". Установка значения NULL очищает настройки "return=representation" и "return=minimal". Возвращает значение true, если предпочтение "return=representation" находится в заголовке. В противном случае возвращает значение false, если значение "return=minimal" находится в заголовке . Возврат значения NULL означает, что "return=representation" и "return=minimal" не указаны в заголовке.
TrackChanges	Свойство для получения и задания параметра "odata.track-changes" в качестве заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Значение true задает параметр "odata.track-changes". Если задано значение false, параметр odata.track-changes будет снят. Возвращает значение true для параметра "odata.track-changes" в заголовке. В противном случае возвращает значение false, если "odata.track-changes" не находится в заголовке.
Wait	Свойство для получения и задания параметра "ожидание" в качестве заголовка "Prefer" в базовом объекте IODataRequestMessage или заголовка "Preference-Applied" в базовом ioDataResponseMessage. Параметр N задает параметр "wait=N". Если задать значение NULL, параметр "ожидание" будет снят. Возвращает N, если параметр "wait=N" находится в заголовке. Возвращая значение NULL, означает, что "wait" не находится в заголовке.

Методы

Clear(String)	Очищает из заголовка preference Prefer в базовом объекте IODataRequestMessage или из заголовка Preference-Applied в базовом ioDataResponseMessage.
Get(String)	Получает из preferenceName заголовка Prefer из базового IODataRequestMessage или из базового заголовка Preferr-Applied из базового IODataResponseMessage.
Set(HttpHeaderValueElement)	Задает заголовок preference Prefer в базовом объекте IODataRequestMessage или заголовок Preference-Applied в базовом объекте IODataResponseMessage.