netFramework/Microsoft.OData.Core.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.OData.Core</name> </assembly> <members> <member name="T:Microsoft.OData.AnnotationFilter"> <summary> Filter class to determine whether or not to read an annotation. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilter.IncludeAll"> <summary> Filter that matches all annotation names. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilter.ExcludeAll"> <summary> Filter than matches no annotation names. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilter.AnnotationFilterPatternSeparator"> <summary> Separator for annotation filter patterns. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilter.prioritizedPatternsToMatch"> <summary> Patterns to match, sorted in the order of higher to lower priorities to match. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilter.#ctor(Microsoft.OData.AnnotationFilterPattern[])"> <summary> Private constructor to create a filter from comma delimited patterns to match to include or exclude annotations. </summary> <param name="prioritizedPatternsToMatch">Patters to match to include or exclude annotations.</param> </member> <member name="M:Microsoft.OData.AnnotationFilter.Create(System.String)"> <summary> Create a filter from comma delimited patterns to match to include or exclude annotations. </summary> <param name="filter">Comma delimited patterns to match to include or exclude annotations.</param> <returns>The newly created filter.</returns> </member> <member name="M:Microsoft.OData.AnnotationFilter.CreateIncludeAllFilter"> <summary> Create a filter that include all. </summary> <returns>The include all filter.</returns> </member> <member name="M:Microsoft.OData.AnnotationFilter.Matches(System.String)"> <summary> Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise. </summary> <param name="annotationName">The name of the annotation in question.</param> <returns>Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AnnotationFilter.IncludeAllFilter"> <summary> Filter to read all annotations. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilter.IncludeAllFilter.#ctor"> <summary> Private default constructor. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilter.IncludeAllFilter.Matches(System.String)"> <summary> Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise. </summary> <param name="annotationName">The name of the annotation in question.</param> <returns>Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AnnotationFilter.ExcludeAllFilter"> <summary> Filter to read no annotation. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilter.ExcludeAllFilter.#ctor"> <summary> Private default constructor. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilter.ExcludeAllFilter.Matches(System.String)"> <summary> Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise. </summary> <param name="annotationName">The name of the annotation in question.</param> <returns>Returns true to indicate that the annotation with the name <paramref name="annotationName"/> should be read, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AnnotationFilterPattern"> <summary> Filter pattern class to determine whether an annotation name matches the pattern. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.IncludeAllPattern"> <summary> The "*" pattern that includes all annotations. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.ExcludeAllPattern"> <summary> The "-*" pattern that excludes all annotations. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.Pattern"> <summary> The pattern to match. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.NamespaceSeparator"> <summary> The '.' namespace separator. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.ExcludeOperator"> <summary> The '-' operator to indicate that the annotation should be excluded from read when it matches the pattern. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.WildCard"> <summary> The wild card constant. </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.DotStar"> <summary> String constant for .* </summary> </member> <member name="F:Microsoft.OData.AnnotationFilterPattern.isExclude"> <summary> true if the annotation should be excluded from reading when its name matches this pattern; false otherwise. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.#ctor(System.String,System.Boolean)"> <summary> Constructs a pattern instance to determine whether an annotation name matches the pattern. </summary> <param name="pattern">The pattern to match.</param> <param name="isExclude">true if the annotation should be excluded from reading when its name matches this pattern; false otherwise.</param> </member> <member name="P:Microsoft.OData.AnnotationFilterPattern.IsExclude"> <summary> true if the annotation should be excluded from reading when its name matches this pattern; false otherwise. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.CompareTo(Microsoft.OData.AnnotationFilterPattern)"> <summary> Compares the priority of current pattern with the priority of <paramref name="other"/>. </summary> <returns> A 32-bit signed integer that indicates the relative priority of the patterns being compared. The return value has the following meanings: -1 means this pattern has higher priority than <paramref name="other"/>. 0 means this pattern has the same priority as <paramref name="other"/>. 1 means this pattern has lower priority than <paramref name="other"/>. </returns> <param name="other">A pattern to compare with this pattern.</param> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.Create(System.String)"> <summary> Creates a pattern instance to determine whether an annotation name matches the pattern. </summary> <param name="pattern">The pattern for this instance.</param> <returns>The newly created <see cref="T:Microsoft.OData.AnnotationFilterPattern"/> instance.</returns> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.Sort(Microsoft.OData.AnnotationFilterPattern[])"> <summary> Sorts the patterns in the array from highest to lowest priorities. </summary> <param name="pattersToSort">The source array to sort. When the method returns the items in this array instance will be rearranged.</param> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.Matches(System.String)"> <summary> Match the given annotation name against the pattern. </summary> <param name="annotationName">Annotation name in question.</param> <returns>Returns true if the given annotation name matches the pattern, false otherwise.</returns> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.ComparePatternPriority(System.String,System.String)"> <summary> Compares the priority of <paramref name="pattern1"/> with <paramref name="pattern2"/>. </summary> <param name="pattern1">The left hand side pattern to compare.</param> <param name="pattern2">The right hand side pattern to compare.</param> <returns> A 32-bit signed integer that indicates the relative priority of the patterns being compared. The return value has the following meanings: -1 means <paramref name="pattern1"/> has higher priority than <paramref name="pattern2"/>. 0 means <paramref name="pattern1"/> has same priority as <paramref name="pattern2"/>. 1 means <paramref name="pattern1"/> has lower priority than <paramref name="pattern2"/>. </returns> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.RemoveExcludeOperator(System.String@)"> <summary> Removes the exclude operator from the given pattern string. </summary> <param name="pattern">The input pattern to the method and will return the pattern without the exclude operator if it's found.</param> <returns>Returns true if the exclude operator is found and removed from the input pattern; false otherwise.</returns> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.ValidatePattern(System.String)"> <summary> Validates the pattern. </summary> <param name="pattern">The pattern to validate.</param> </member> <member name="T:Microsoft.OData.AnnotationFilterPattern.WildCardPattern"> <summary> The wild card pattern that matches everything. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.WildCardPattern.#ctor(System.Boolean)"> <summary> Constructs the wild card pattern. </summary> <param name="isExclude">true if the annotation should be excluded from reading when its name matches this pattern; false otherwise.</param> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.WildCardPattern.Matches(System.String)"> <summary> Match the given annotation name against the pattern. </summary> <param name="annotationName">Annotation name in question.</param> <returns>Returns true if the given annotation name matches the pattern, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AnnotationFilterPattern.StartsWithPattern"> <summary> Pattern class to match any annotation name that starts with this pattern. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.StartsWithPattern.#ctor(System.String,System.Boolean)"> <summary> Constructs the starts with pattern. </summary> <param name="pattern">The pattern to start with.</param> <param name="isExclude">true if the annotation should be excluded from reading when its name matches this pattern; false otherwise.</param> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.StartsWithPattern.Matches(System.String)"> <summary> Match the given annotation name against the pattern. </summary> <param name="annotationName">Annotation name in question.</param> <returns>Returns true if the given annotation name matches the pattern, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AnnotationFilterPattern.ExactMatchPattern"> <summary> Pattern class to match an annotation name that is exactly the same as this pattern. </summary> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.ExactMatchPattern.#ctor(System.String,System.Boolean)"> <summary> Constructs the exact match pattern. </summary> <param name="pattern">The exact pattern to match</param> <param name="isExclude">true if the annotation should be excluded from reading when its name matches this pattern; false otherwise.</param> </member> <member name="M:Microsoft.OData.AnnotationFilterPattern.ExactMatchPattern.Matches(System.String)"> <summary> Match the given annotation name against the pattern. </summary> <param name="annotationName">Annotation name in question.</param> <returns>Returns true if the given annotation name matches the pattern, false otherwise.</returns> </member> <member name="T:Microsoft.OData.AsyncBufferedStream"> <summary> Write-only stream which buffers all synchronous write operations until FlushAsync is called. </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.innerStream"> <summary> The stream being wrapped. </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.bufferQueue"> <summary> Queue of buffers to write. </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.bufferToAppendTo"> <summary> The last buffer in the bufferQueue. This is the buffer we're writing into. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.#ctor(System.IO.Stream)"> <summary> Constructor </summary> <param name="stream">The underlying async stream to wrap. Note that only asynchronous write operation will be invoked on this stream.</param> </member> <member name="P:Microsoft.OData.AsyncBufferedStream.CanRead"> <summary> Determines if the stream can read - this one cannot </summary> </member> <member name="P:Microsoft.OData.AsyncBufferedStream.CanSeek"> <summary> Determines if the stream can seek - this one cannot </summary> </member> <member name="P:Microsoft.OData.AsyncBufferedStream.CanWrite"> <summary> Determines if the stream can write - this one can </summary> </member> <member name="P:Microsoft.OData.AsyncBufferedStream.Length"> <summary> Returns the length of the stream, which this implementation doesn't support. </summary> </member> <member name="P:Microsoft.OData.AsyncBufferedStream.Position"> <summary> Gets or sets the position in the stream, this stream doesn't support seeking, so position is also unsupported. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Flush"> <summary> Flush the stream to the underlying storage. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Read(System.Byte[],System.Int32,System.Int32)"> <summary> Reads data from the stream. This operation is not supported by this stream. </summary> <param name="buffer">The buffer to read the data to.</param> <param name="offset">The offset in the buffer to write to.</param> <param name="count">The number of bytes to read.</param> <returns>The number of bytes actually read.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Seeks the stream. This operation is not supported by this stream. </summary> <param name="offset">The offset to seek to.</param> <param name="origin">The origin of the seek operation.</param> <returns>The new position in the stream.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.SetLength(System.Int64)"> <summary> Sets the length of the stream. This operation is not supported by this stream. </summary> <param name="value">The length in bytes to set.</param> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes to the stream. </summary> <param name="buffer">The buffer to get data from.</param> <param name="offset">The offset in the buffer to start from.</param> <param name="count">The number of bytes to write.</param> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Clear"> <summary> Clears any internal buffers without writing them to the underlying stream. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.FlushSync"> <summary> Synchronous flush operation. This will flush all buffered bytes to the underlying stream through synchronous writes. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.FlushAsync"> <summary> Asynchronous flush operation. This will flush all buffered bytes to the underlying stream through asynchronous writes. </summary> <returns>The task representing the asynchronous flush operation.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.FlushAsyncInternal"> <summary> Asynchronous flush operation. This will flush all buffered bytes to the underlying stream through asynchronous writes. </summary> <returns>The task representing the asynchronous flush operation.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.Dispose(System.Boolean)"> <summary> Disposes the object. </summary> <param name="disposing">True if called from Dispose; false if called from the finalizer.</param> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.QueueNewBuffer"> <summary> Queues a new buffer to the queue of buffers </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.PrepareFlushBuffers"> <summary> Prepares all buffers for flushing and returns the queue of buffers to flush. </summary> <returns>The queue of buffer to flush.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.FlushBuffersAsync(System.Collections.Generic.Queue{Microsoft.OData.AsyncBufferedStream.DataBuffer})"> <summary> Returns enumeration of tasks to run to flush all pending buffers to the underlying stream. </summary> <param name="buffers">The queue of buffers that need to be flushed.</param> <returns>Enumeration of tasks to run to flush all buffers.</returns> <remarks>This method relies on lazy eval of the enumerator, never enumerate through it synchronously.</remarks> </member> <member name="T:Microsoft.OData.AsyncBufferedStream.DataBuffer"> <summary> Class to wrap a byte buffer used to store portion of the buffered data. </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.DataBuffer.BufferSize"> <summary> The size of a buffer to allocate (80 KB is the limit for large object heap, so use 79 to be sure to avoid LOB) </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.DataBuffer.buffer"> <summary> The byte buffer used to store the data. </summary> </member> <member name="F:Microsoft.OData.AsyncBufferedStream.DataBuffer.storedCount"> <summary> Number of bytes being stored. </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.DataBuffer.#ctor"> <summary> Constructor - creates a new buffer </summary> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.DataBuffer.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes data into the buffer. </summary> <param name="data">The buffer containing the data to write.</param> <param name="index">The index to start at.</param> <param name="count">Number of bytes to write.</param> <returns>How many bytes were written.</returns> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.DataBuffer.WriteToStream(System.IO.Stream)"> <summary> Writes the buffer to the specified stream. </summary> <param name="stream">The stream to write the data into.</param> </member> <member name="M:Microsoft.OData.AsyncBufferedStream.DataBuffer.WriteToStreamAsync(System.IO.Stream)"> <summary> Creates a task which writes the buffer to the specified stream. </summary> <param name="stream">The stream to write the data into.</param> <returns>The task which represent the asynchronous write operation.</returns> </member> <member name="T:Microsoft.OData.ODataBatchOperationHeaders"> <summary> A dictionary for storing headers to be used with ODataBatchOperations. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationHeaders.headersDictionary"> <summary>The backing dictionary for headers.</summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.#ctor"> <summary> Constructor. </summary> </member> <member name="P:Microsoft.OData.ODataBatchOperationHeaders.Item(System.String)"> <summary> Gets or sets the element with the specified key. </summary> <param name="key">The key of the element to get or set.</param> <returns>The element with the specified key.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.Add(System.String,System.String)"> <summary> Adds an element with the provided key and value to the dictionary. </summary> <param name="key">The object to use as the key of the element to add.</param> <param name="value">The object to use as the value of the element to add.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.ContainsKeyOrdinal(System.String)"> <summary> Determines whether the dictionary contains an element with the specified key. </summary> <param name="key">The key to locate in the dictionary.</param> <returns>true if the dictionary contains an element with the <paramref name="key"/>; otherwise, false.</returns> <remarks>This method will match the key using case-insensitive comparison.</remarks> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.Remove(System.String)"> <summary> Removes the resource with the specified <paramref name="key"/> from the headers. </summary> <param name="key">The key of the item to remove.</param> <returns>true if the item with the specified <paramref name="key"/> was removed; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.TryGetValue(System.String,System.String@)"> <summary> Gets the value associated with the specified key. </summary> <param name="key">The key whose value to get.</param> <param name="value">When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.</param> <returns>true if the dictionary contains an element with the specified key; otherwise, false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>An enumerator that can be used to iterate through the collection.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationHeaders.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>An enumerator that can be used to iterate through the collection.</returns> </member> <member name="T:Microsoft.OData.ODataBatchOperationMessage"> <summary> Implementation class wrapped by the <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> and <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> implementations. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationMessage.operationListener"> <summary>Listener interface to be notified of operation changes.</summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationMessage.payloadUriConverter"> <summary>The URL converter to perform custom URL conversion for URLs read or written from/to the payload.</summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationMessage.contentStreamCreatorFunc"> <summary>A function to retrieve the content stream for this batch operation message.</summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationMessage.headers"> <summary>The set of headers for this operation.</summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.#ctor(System.Func{System.IO.Stream},Microsoft.OData.ODataBatchOperationHeaders,Microsoft.OData.IODataStreamListener,Microsoft.OData.IODataPayloadUriConverter,System.Boolean)"> <summary> Constructor. Base class constructor to create a message for an operation of a batch request/response. </summary> <param name="contentStreamCreatorFunc">A function to retrieve the content stream for this batch operation message.</param> <param name="headers">The headers of the batch operation message.</param> <param name="operationListener">Listener interface to be notified of part changes.</param> <param name="payloadUriConverter">The URL resolver to perform custom URL resolution for URLs read or written from/to the payload.</param> <param name="writing">true if the request message is being written; false when it is read.</param> </member> <member name="P:Microsoft.OData.ODataBatchOperationMessage.Headers"> <summary> Returns an enumerable over all the headers for this message. </summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.GetHeader(System.String)"> <summary> Returns a value of an HTTP header of this operation. </summary> <param name="headerName">The name of the header to get.</param> <returns>The value of the HTTP header, or null if no such header was present on the message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.SetHeader(System.String,System.String)"> <summary> Sets the value of an HTTP header of this operation. </summary> <param name="headerName">The name of the header to set.</param> <param name="headerValue">The value of the HTTP header or 'null' if the header should be removed.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.GetStream"> <summary> Get the stream backing this message. </summary> <returns>The stream for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.GetStreamAsync"> <summary> Asynchronously get the stream backing this message. </summary> <returns>The stream for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.QueryInterface``1"> <summary> Queries the message for the specified interface type. </summary> <typeparam name="TInterface">The type of the interface to query for.</typeparam> <returns>The instance of the interface asked for or null if it was not implemented by the message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.ResolveUrl(System.Uri,System.Uri)"> <summary> Method to implement a custom URL resolution scheme. This method returns null if not custom resolution is desired. If the method returns a non-null URL that value will be used without further validation. </summary> <param name="baseUri">The (optional) base URI to use for the resolution.</param> <param name="payloadUri">The URI read from the payload.</param> <returns> A <see cref="T:System.Uri"/> instance that reflects the custom resolution of the method arguments into a URL or null if no custom resolution is desired; in that case the default resolution is used. </returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.PartHeaderProcessingCompleted"> <summary> Indicates that the headers and request/response line have been read or written. Can be called only once per batch part and headers cannot be modified anymore after this method was called. </summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationMessage.VerifyNotCompleted"> <summary> Verifies that writing of the message has not been completed; this is called from all methods that are only valid to be called before the message content is written or the message </summary> </member> <member name="T:Microsoft.OData.ODataBatchOperationRequestMessage"> <summary> Message representing an operation in a batch request. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationRequestMessage.ContentId"> <summary> The Content-ID for this request message.</summary> <returns>The Content-ID for this request message.</returns> </member> <member name="F:Microsoft.OData.ODataBatchOperationRequestMessage.groupId"> <summary> The Group Id for this request message. Can be null. </summary> <returns>The Group Id for this request message.</returns> </member> <member name="F:Microsoft.OData.ODataBatchOperationRequestMessage.message"> <summary> The actual implementation of the message. We don't derive from this class since we want the actual implementation to remain internal while this class is public. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationRequestMessage.dependsOnIds"> <summary> The list of request prerequisites for execution of current batch operation. ODL-caller needs to ensure that all the prerequisites have returned successfully before current operation can start. </summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.#ctor(System.Func{System.IO.Stream},System.String,System.Uri,Microsoft.OData.ODataBatchOperationHeaders,Microsoft.OData.IODataStreamListener,System.String,Microsoft.OData.IODataPayloadUriConverter,System.Boolean,System.IServiceProvider,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Constructor. Creates a request message for an operation of a batch request. </summary> <param name="contentStreamCreatorFunc">A function to create the content stream.</param> <param name="method">The HTTP method used for this request message.</param> <param name="requestUrl">The request Url for this request message.</param> <param name="headers">The headers for this request message.</param> <param name="operationListener">Listener interface to be notified of operation changes.</param> <param name="contentId">The content-ID for the operation request message.</param> <param name="payloadUriConverter">The optional URL converter to perform custom URL conversion for URLs written to the payload.</param> <param name="writing">true if the request message is being written; false when it is read.</param> <param name="container">The dependency injection container to get related services.</param> <param name="dependsOnIds"> Request or group Ids that current request has dependency on. Values are added to a new list. Empty list will be created if value is null. </param> <param name="groupId">Value for the group id that current request belongs to. Can be null.</param> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.Headers"> <summary>Gets an enumerable over all the headers for this message.</summary> <returns>An enumerable over all the headers for this message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.Url"> <summary>Gets or sets the request URL for this request message.</summary> <returns>The request URL for this request message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.Method"> <summary>Gets or Sets the HTTP method used for this request message.</summary> <returns>The HTTP method used for this request message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.Container"> <summary> The dependency injection container to get related services. </summary> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.GroupId"> <summary> The Group Id for this request message. Can be null. </summary> <returns>The Group Id for this request message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.DependsOnIds"> <summary> Gets the prerequisite request or group ids. </summary> </member> <member name="P:Microsoft.OData.ODataBatchOperationRequestMessage.OperationMessage"> <summary> Returns the actual operation message which is being wrapped. </summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.GetHeader(System.String)"> <summary>Returns a value of an HTTP header of this operation.</summary> <returns>The value of the HTTP header, or null if no such header was present on the message.</returns> <param name="headerName">The name of the header to get.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.SetHeader(System.String,System.String)"> <summary>Sets the value of an HTTP header of this operation.</summary> <param name="headerName">The name of the header to set.</param> <param name="headerValue">The value of the HTTP header or 'null' if the header should be removed.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.GetStream"> <summary>Gets the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.GetStreamAsync"> <summary>Asynchronously get the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationRequestMessage.Microsoft#OData#IODataPayloadUriConverter#ConvertPayloadUri(System.Uri,System.Uri)"> <summary>Implements a custom URL resolution scheme.</summary> <returns>A <see cref="T:System.Uri"/> instance that reflects the custom resolution of the method arguments into a URL or null if no custom resolution is desired; in that case the default resolution is used.</returns> <param name="baseUri">The (optional) base URI to use for the resolution.</param> <param name="payloadUri">The URI read from the payload.</param> </member> <member name="T:Microsoft.OData.ODataBatchOperationResponseMessage"> <summary> Message representing an operation in a batch response. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationResponseMessage.ContentId"> <summary>The Content-ID for this response message.</summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationResponseMessage.message"> <summary> The actual implementation of the message. We don't derive from this class since we want the actual implementation to remain internal while this class is public. </summary> </member> <member name="F:Microsoft.OData.ODataBatchOperationResponseMessage.statusCode"> <summary>The result status code of the response message.</summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.#ctor(System.Func{System.IO.Stream},Microsoft.OData.ODataBatchOperationHeaders,Microsoft.OData.IODataStreamListener,System.String,Microsoft.OData.IODataPayloadUriConverter,System.Boolean,System.IServiceProvider,System.String)"> <summary> Constructor. </summary> <param name="contentStreamCreatorFunc">A function to retrieve the content stream for this batch operation message.</param> <param name="headers">The headers of the batch operation message.</param> <param name="operationListener">Listener interface to be notified of part changes.</param> <param name="contentId">The content-ID for the operation response message.</param> <param name="payloadUriConverter">The optional URL converter to perform custom URL conversion for URLs written to the payload.</param> <param name="writing">true if the request message is being written; false when it is read.</param> <param name="container">The dependency injection container to get related services.</param> <param name="groupId">Value for the group id that corresponding request belongs to. Can be null.</param> </member> <member name="P:Microsoft.OData.ODataBatchOperationResponseMessage.StatusCode"> <summary>Gets or sets the result status code of the response message.</summary> <returns>The result status code of the response message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationResponseMessage.Headers"> <summary>Gets an enumerable over all the headers for this message.</summary> <returns>An enumerable over all the headers for this message.</returns> </member> <member name="P:Microsoft.OData.ODataBatchOperationResponseMessage.Container"> <summary> The dependency injection container to get related services. </summary> </member> <member name="P:Microsoft.OData.ODataBatchOperationResponseMessage.GroupId"> <summary> The id of the group or change set that this response message is part of. </summary> </member> <member name="P:Microsoft.OData.ODataBatchOperationResponseMessage.OperationMessage"> <summary> Returns the actual operation message which is being wrapped. </summary> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.GetHeader(System.String)"> <summary>Returns a value of an HTTP header of this operation.</summary> <returns>The value of the HTTP header, or null if no such header was present on the message.</returns> <param name="headerName">The name of the header to get.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.SetHeader(System.String,System.String)"> <summary>Sets the value of an HTTP header of this operation.</summary> <param name="headerName">The name of the header to set.</param> <param name="headerValue">The value of the HTTP header or null if the header should be removed.</param> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.GetStream"> <summary>Gets the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.GetStreamAsync"> <summary>Asynchronously get the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchOperationResponseMessage.Microsoft#OData#IODataPayloadUriConverter#ConvertPayloadUri(System.Uri,System.Uri)"> <summary> Method to implement a custom URL resolution scheme. This method returns null if not custom resolution is desired. If the method returns a non-null URL that value will be used without further validation. </summary> <returns> A <see cref="T:System.Uri" /> instance that reflects the custom resolution of the method arguments into a URL or null if no custom resolution is desired; in that case the default resolution is used. </returns> <param name="baseUri">The (optional) base URI to use for the resolution.</param> <param name="payloadUri">The URI read from the payload.</param> </member> <member name="T:Microsoft.OData.ODataBatchPayloadUriConverter"> <summary> Implementation of the batch-specific URL converter that converts cross-referencing URLs properly. </summary> </member> <member name="F:Microsoft.OData.ODataBatchPayloadUriConverter.batchMessagePayloadUriConverter"> <summary>The URL converter from the batch message.</summary> </member> <member name="F:Microsoft.OData.ODataBatchPayloadUriConverter.contentIdCache"> <summary>A hashset with all content IDs used so far in the batch; this is used for cross-referencing URL conversion.</summary> </member> <member name="M:Microsoft.OData.ODataBatchPayloadUriConverter.#ctor(Microsoft.OData.IODataPayloadUriConverter)"> <summary> Constructor. </summary> <param name="batchMessagePayloadUriConverter">The URL converter from the batch message.</param> </member> <member name="P:Microsoft.OData.ODataBatchPayloadUriConverter.BatchMessagePayloadUriConverter"> <summary> The URL converter from the batch message. </summary> </member> <member name="P:Microsoft.OData.ODataBatchPayloadUriConverter.ContentIdCache"> <summary> A read-only enumeration of <code>contentIdCache</code>. </summary> </member> <member name="M:Microsoft.OData.ODataBatchPayloadUriConverter.Microsoft#OData#IODataPayloadUriConverter#ConvertPayloadUri(System.Uri,System.Uri)"> <summary> Method to implement a custom URL conversion scheme. This method returns null if not custom conversion is desired. If the method returns a non-null URL that value will be used without further validation. </summary> <param name="baseUri">The (optional) base URI to use for the conversion.</param> <param name="payloadUri">The URI read from the payload.</param> <returns> A <see cref="T:System.Uri"/> instance that reflects the custom conversion of the method arguments into a URL or null if no custom conversion is desired; in that case the default conversion is used. </returns> </member> <member name="M:Microsoft.OData.ODataBatchPayloadUriConverter.AddContentId(System.String)"> <summary> Add the content ID to the hashset of valid content IDs. </summary> <param name="contentId">The (non-null) content ID to add.</param> </member> <member name="M:Microsoft.OData.ODataBatchPayloadUriConverter.ContainsContentId(System.String)"> <summary> Checks whether a given (non-null) content ID is already in the content ID cache. </summary> <param name="contentId">The content ID to check for.</param> <returns>true if the content ID cache already contains a content ID with value <paramref name="contentId"/>; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchPayloadUriConverter.Reset"> <summary> Resets the cache of content IDs. This is called at the end of each changeset since content IDs are only unique within a changeset. </summary> </member> <member name="T:Microsoft.OData.BatchPayloadUriOption"> <summary> Indicates the format of Request-URI in each sub request in the batch operation. </summary> </member> <member name="F:Microsoft.OData.BatchPayloadUriOption.AbsoluteUri"> <summary> Absolute URI with schema, host, port, and absolute resource path. </summary> Example: GET https://host:1234/path/service/People(1) HTTP/1.1 </member> <member name="F:Microsoft.OData.BatchPayloadUriOption.AbsoluteUriUsingHostHeader"> <summary> Absolute resource path and separate Host header. </summary> Example: GET /path/service/People(1) HTTP/1.1 Host: myserver.mydomain.org:1234 </member> <member name="F:Microsoft.OData.BatchPayloadUriOption.RelativeUri"> <summary> Resource path relative to the batch request URI. </summary> Example: GET People(1) HTTP/1.1 </member> <member name="T:Microsoft.OData.ODataBatchReader"> <summary> Abstract class for reading OData batch messages; also verifies the proper sequence of read calls on the reader. </summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.PayloadUriConverter"> <summary>The batch-specific URL converter that stores the content IDs found in a changeset and supports resolving cross-referencing URLs.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.inputContext"> <summary>The input context to read the content from.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.synchronous"> <summary>True if the writer was created for synchronous operation; false for asynchronous.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.container"> <summary>The dependency injection container to get related services.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.batchReaderState"> <summary>The current state of the batch reader.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.currentBatchSize"> <summary>The current size of the batch message, i.e., how many query operations and changesets have been read.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.currentChangeSetSize"> <summary>The current size of the active changeset, i.e., how many operations have been read for the changeset.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.operationState"> <summary>An enumeration tracking the state of the current batch operation.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.isInChangeset"> <summary>Whether the reader is currently reading within a changeset.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.contentIdToAddOnNextRead"> <summary> Content-ID header value for request part with associated entity, which can be referenced by subsequent requests in the same changeset or other changesets. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.#ctor(Microsoft.OData.ODataInputContext,System.Boolean)"> <summary> Constructor. </summary> <param name="inputContext">The input context to read the content from.</param> <param name="synchronous">true if the reader is created for synchronous operation; false for asynchronous.</param> </member> <member name="T:Microsoft.OData.ODataBatchReader.OperationState"> <summary> An enumeration to track the state of a batch operation. </summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.OperationState.None"> <summary>No action has been performed on the operation.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.OperationState.MessageCreated"> <summary>The batch message for the operation has been created and returned to the caller.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.OperationState.StreamRequested"> <summary>The stream of the batch operation message has been requested.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReader.OperationState.StreamDisposed"> <summary>The stream of the batch operation message has been disposed.</summary> </member> <member name="P:Microsoft.OData.ODataBatchReader.State"> <summary>Gets the current state of the batch reader.</summary> <returns>The current state of the batch reader.</returns> </member> <member name="P:Microsoft.OData.ODataBatchReader.CurrentGroupId"> <summary> Public property for the current group id the reader is processing. The primary usage of this to correlate atomic group id in request and response operation messages as needed. </summary> </member> <member name="P:Microsoft.OData.ODataBatchReader.InputContext"> <summary> The input context to read the content from. </summary> </member> <member name="P:Microsoft.OData.ODataBatchReader.ReaderOperationState"> <summary> The reader's Operation state </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.Read"> <summary> Reads the next part from the batch message payload. </summary> <returns>True if more items were read; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAsync"> <summary>Asynchronously reads the next part from the batch message payload.</summary> <returns>A task that when completed indicates whether more items were read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationRequestMessage"> <summary>Returns an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for reading the content of a batch operation.</summary> <returns>A request message for reading the content of a batch operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationRequestMessageAsync"> <summary>Asynchronously returns an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for reading the content of a batch operation.</summary> <returns>A task that when completed returns a request message for reading the content of a batch operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationResponseMessage"> <summary>Returns an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage" /> for reading the content of a batch operation.</summary> <returns>A response message for reading the content of a batch operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationResponseMessageAsync"> <summary>Asynchronously returns an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage" /> for reading the content of a batch operation.</summary> <returns>A task that when completed returns a response message for reading the content of a batch operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.Microsoft#OData#IODataStreamListener#StreamRequested"> <summary> This method is called to notify that the content stream for a batch operation has been requested. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.Microsoft#OData#IODataStreamListener#StreamRequestedAsync"> <summary> This method is called to notify that the content stream for a batch operation has been requested. </summary> <returns> A task representing any action that is running as part of the status change of the reader; null if no such action exists. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.Microsoft#OData#IODataStreamListener#StreamDisposed"> <summary> This method is called to notify that the content stream of a batch operation has been disposed. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.Microsoft#OData#IODataStreamListener#StreamDisposedAsync"> <summary> This method is called asynchronously to notify that the content stream of a batch operation has been disposed. </summary> <returns>A task that represents the asynchronous operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ThrowODataException(System.String)"> <summary> Sets the 'Exception' state and then throws an ODataException with the specified error message. </summary> <param name="errorMessage">The error message for the exception.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.GetCurrentGroupIdImplementation"> <summary> Gets the group id for the current request. Default implementation here is provided returning null. </summary> <returns>The group id for the current request.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationRequestMessageImplementation"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> for reading the content of an operation in a batch request. </summary> <returns>The message that can be used to read the content of the batch request operation from.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationResponseMessageImplementation"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> for reading the content of an operation in a batch request. </summary> <returns>The message that can be used to read the content of the batch response operation from.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtStartImplementation"> <summary> Implementation of the reader logic when in state 'Start'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtOperationImplementation"> <summary> Implementation of the reader logic when in state 'Operation'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtChangesetStartImplementation"> <summary> Implementation of the reader logic when in state 'ChangesetStart'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtChangesetEndImplementation"> <summary> Implementation of the reader logic when in state 'ChangesetEnd'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ValidateDependsOnIds(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Validate the dependsOnIds. </summary> <param name="contentId">The request Id</param> <param name="dependsOnIds">The dependsOn ids specifying current request's prerequisites.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.BuildOperationRequestMessage(System.Func{System.IO.Stream},System.String,System.Uri,Microsoft.OData.ODataBatchOperationHeaders,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> Instantiate an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> instance. </summary> <param name="streamCreatorFunc">The function for stream creation.</param> <param name="method">The HTTP method used for this request message.</param> <param name="requestUri">The request Url for this request message.</param> <param name="headers">The headers for this request message.</param> <param name="contentId">The contentId of this request message.</param> <param name="groupId">The group id that this request belongs to. Can be null.</param> <param name="dependsOnRequestIds"> The prerequisite request Ids of this request message that could be specified by caller explicitly. </param> <param name="dependsOnIdsValidationRequired"> Whether the <code>dependsOnIds</code> value needs to be validated.</param> <returns>The <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> instance.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.BuildOperationResponseMessage(System.Func{System.IO.Stream},System.Int32,Microsoft.OData.ODataBatchOperationHeaders,System.String,System.String)"> <summary> Instantiate an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> instance and set the status code. </summary> <param name="streamCreatorFunc">The function for stream creation.</param> <param name="statusCode">The status code for the response.</param> <param name="headers">The headers for this response message.</param> <param name="contentId">The contentId of this request message.</param> <param name="groupId">The groupId of this request message.</param> <returns>The <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> instance.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationRequestMessageImplementationAsync"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> for reading the content of an operation in a batch request. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> that can be used to read the content of the batch request operation from. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.CreateOperationResponseMessageImplementationAsync"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> for reading the content of an operation in a batch response. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> that can be used to read the content of the batch response operation from. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtStartImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'Start'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtOperationImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'Operation'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtChangesetStartImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'ChangesetStart'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAtChangesetEndImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'ChangesetEnd'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.IncreaseBatchSize"> <summary> Increases the size of the current batch message; throws if the allowed limit is exceeded. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.IncreaseChangesetSize"> <summary> Increases the size of the current change set; throws if the allowed limit is exceeded. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.ResetChangesetSize"> <summary> Resets the size of the current change set to 0. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadSynchronously"> <summary> Reads the next part from the batch message payload. </summary> <returns>true if more information was read; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadAsynchronously"> <summary> Asynchronously reads the next part from the batch message payload. </summary> <returns>A task that when completed indicates whether more information was read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadImplementation"> <summary> Continues reading from the batch message payload. </summary> <returns>true if more items were read; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.ReadImplementationAsync"> <summary> Asynchronously continues reading from the batch message payload. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains true if more items were read; otherwise false. </returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.VerifyCanCreateOperationRequestMessage(System.Boolean)"> <summary> Verifies that calling CreateOperationRequestMessage if valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.VerifyCanCreateOperationResponseMessage(System.Boolean)"> <summary> Verifies that calling CreateOperationResponseMessage if valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.VerifyCanRead(System.Boolean)"> <summary> Verifies that calling Read is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.VerifyReaderReady"> <summary> Validates that the batch reader is ready to process a new read or create message request. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReader.VerifyCallAllowed(System.Boolean)"> <summary> Verifies that a call is allowed to the reader. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchReader.InterceptException``1(System.Func{Microsoft.OData.ODataBatchReader,``0})"> <summary> Catch any exception thrown by the action passed in; in the exception case move the writer into state Exception and then rethrow the exception. </summary> <typeparam name="T">The type of the result returned from the <paramref name="action"/>.</typeparam> <param name="action">The action to execute.</param> <returns>The result of the <paramref name="action"/>.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReader.InterceptExceptionAsync``1(System.Func{Microsoft.OData.ODataBatchReader,System.Threading.Tasks.Task{``0}})"> <summary> Catch any exception thrown by the action passed in; in the exception case move the writer into state Exception and then rethrow the exception. </summary> <typeparam name="TResult">The type of the result returned from the <paramref name="action"/>.</typeparam> <param name="action">The action to execute.</param> <returns> A task that represents the asynchronous operation. The value of the TResult parameter contains the result of executing the <paramref name="action"/>. </returns> </member> <member name="T:Microsoft.OData.ODataBatchReaderState"> <summary>Enumeration with all the states the batch reader can be in.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.Initial"> <summary>The state the batch reader is in after having been created.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.Operation"> <summary>The batch reader detected an operation.</summary> <remarks>In this state the start boundary, the request/response line and the operation headers have already been read.</remarks> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.ChangesetStart"> <summary>The batch reader detected the start of a change set.</summary> <remarks>In this state the start boundary and the change set headers have already been read.</remarks> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.ChangesetEnd"> <summary>The batch reader completed reading a change set.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.Completed"> <summary>The batch reader completed reading the batch payload.</summary> <remarks>The batch reader cannot be used in this state anymore.</remarks> </member> <member name="F:Microsoft.OData.ODataBatchReaderState.Exception"> <summary>The batch reader encountered an error reading the batch payload.</summary> <remarks>The batch reader cannot be used in this state anymore.</remarks> </member> <member name="T:Microsoft.OData.ODataBatchReaderStream"> <summary> Class used by the <see cref="T:Microsoft.OData.ODataBatchReader"/> to read the various pieces of a batch payload. </summary> <remarks> This is the base class for format-specific derived classes to process batch requests in different formats, such as multipart/mixed format and application/json format. </remarks> </member> <member name="F:Microsoft.OData.ODataBatchReaderStream.BatchBuffer"> <summary>The buffer used by the batch reader stream to scan for boundary strings.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStream.underlyingStreamExhausted"> <summary> true if the underlying stream was exhausted during a read operation; we won't try to read from the underlying stream again once it was exhausted. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReaderStream.#ctor"> <summary> Constructor. </summary> </member> <member name="M:Microsoft.OData.ODataBatchReaderStream.ReadWithDelimiter(System.Byte[],System.Int32,System.Int32)"> <summary> Reads from the batch stream while ensuring that we stop reading at each boundary. </summary> <param name="userBuffer">The byte array to read bytes into.</param> <param name="userBufferOffset">The offset in the buffer where to start reading bytes into.</param> <param name="count">The number of bytes to read.</param> <returns>The number of bytes actually read.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStream.ReadWithLength(System.Byte[],System.Int32,System.Int32)"> <summary> Reads from the batch stream without checking for a boundary delimiter since we know the length of the stream. </summary> <param name="userBuffer">The byte array to read bytes into.</param> <param name="userBufferOffset">The offset in the buffer where to start reading bytes into.</param> <param name="count">The number of bytes to read.</param> <returns>The number of bytes actually read.</returns> </member> <member name="T:Microsoft.OData.ODataBatchReaderStreamBuffer"> <summary> This class represents the internal buffer of the <see cref="T:Microsoft.OData.ODataBatchReaderStream"/>. </summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.BufferLength"> <summary>The size of the look-ahead buffer.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.MaxLineFeedLength"> <summary>Length of the longest supported line terminator character sequence; makes the code easier to read.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.TwoDashesLength"> <summary>The length of two '-' characters to make the code easier to read.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.bytes"> <summary>The byte array storing the actual bytes of the buffer.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.currentReadPosition"> <summary>The current position inside the buffer.</summary> <remarks>This is the position of the byte that is the next to be read.</remarks> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamBuffer.numberOfBytesInBuffer"> <summary>The number of (not yet consumed) bytes currently in the buffer.</summary> </member> <member name="P:Microsoft.OData.ODataBatchReaderStreamBuffer.Bytes"> <summary> The byte array that acts as the actual storage of the buffered data. </summary> </member> <member name="P:Microsoft.OData.ODataBatchReaderStreamBuffer.CurrentReadPosition"> <summary> The current position inside the buffer. </summary> <remarks>This is the position of the byte that is the next to be read.</remarks> </member> <member name="P:Microsoft.OData.ODataBatchReaderStreamBuffer.NumberOfBytesInBuffer"> <summary> The number of (not yet consumed) bytes currently in the buffer. </summary> </member> <member name="P:Microsoft.OData.ODataBatchReaderStreamBuffer.Item(System.Int32)"> <summary> Indexer into the byte buffer. </summary> <param name="index">The position in the buffer to get.</param> <returns>The byte at position <paramref name="index"/> in the buffer.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.SkipTo(System.Int32)"> <summary> Skip to the specified position in the buffer. Adjust the current position and the number of bytes in the buffer. </summary> <param name="newPosition">The position to skip to.</param> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.RefillFrom(System.IO.Stream,System.Int32)"> <summary> Refills the buffer from the specified stream. </summary> <param name="stream">The stream to refill the buffer from.</param> <param name="preserveFrom">The index in the current buffer starting from which the currently buffered data should be preserved.</param> <returns>true if the underlying stream got exhausted while refilling.</returns> <remarks>This method will first shift any data that is to be preserved to the beginning of the buffer and then refill the rest of the buffer from the <paramref name="stream"/>.</remarks> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.ScanForLineEnd(System.Int32@,System.Int32@)"> <summary> Scans the current buffer for a line end. </summary> <param name="lineEndStartPosition">The start position of the line terminator or -1 if not found.</param> <param name="lineEndEndPosition">The end position of the line terminator or -1 if not found.</param> <returns>An enumeration value indicating whether the line terminator was found completely, partially or not at all.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.ScanForBoundary(System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Int32@,System.Int32@,System.Boolean@,System.Boolean@)"> <summary> Scans the current buffer for the specified boundary. </summary> <param name="boundaries">The boundary strings to search for; this enumerable is sorted from the inner-most boundary to the top-most boundary. The boundary strings don't include the leading line terminator or the leading dashes.</param> <param name="maxDataBytesToScan">Stop if no boundary (or boundary start) is found after this number of bytes.</param> <param name="boundaryStartPosition">The start position of the boundary or -1 if not found. Note that the start position is the first byte of the leading line terminator.</param> <param name="boundaryEndPosition">The end position of the boundary or -1 if not found. Note that the end position is the last byte of the trailing line terminator.</param> <param name="isEndBoundary">true if the boundary is an end boundary (followed by two dashes); otherwise false.</param> <param name="isParentBoundary">true if the detected boundary is the parent boundary; otherwise false.</param> <returns>An enumeration value indicating whether the boundary was completely, partially or not found in the buffer.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.ScanForBoundaryStart(System.Int32,System.Int32,System.Int32@,System.Int32@)"> <summary> Scans the current buffer for a boundary start, which is either a line resource set or two dashes (since we don't require the leading line resource set). </summary> <param name="scanStartIx">The index at which to start scanning for the boundary start.</param> <param name="maxDataBytesToScan">Stop if no boundary start was found after this number of non end-of-line bytes.</param> <param name="lineEndStartPosition">The start position of the line end or -1 if not found.</param> <param name="boundaryDelimiterStartPosition">The start position of the boundary delimiter or -1 if not found.</param> <returns>An enumeration value indicating whether the boundary start was completely, partially or not found in the buffer.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.ScanForLineEnd(System.Int32,System.Int32,System.Boolean,System.Int32@,System.Int32@,System.Boolean@)"> <summary> Scans the current buffer for a line end. </summary> <param name="scanStartIx">The index at which to start scanning for the line terminator.</param> <param name="maxDataBytesToScan">Stop if no line end (or beginning of line end) was found after this number of non end-of-line bytes.</param> <param name="allowLeadingWhitespaceOnly">true if only whitespace data bytes are expected before the end-of-line characters; otherwise false.</param> <param name="lineEndStartPosition">The start position of the line terminator or -1 if not found.</param> <param name="lineEndEndPosition">The end position of the line terminator or -1 if not found.</param> <param name="endOfBufferReached">true if the end of the buffer was reached while scanning for the line end; otherwise false.</param> <returns>An enumeration value indicating whether the line terminator was found completely, partially or not at all.</returns> <remarks>This method only returns <see cref="F:Microsoft.OData.ODataBatchReaderStreamScanResult.PartialMatch"/> if we found the start of a line terminator at the last character in the buffer.</remarks> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.MatchBoundary(System.Int32,System.Int32,System.String,System.Int32@,System.Int32@,System.Boolean@)"> <summary> Check whether the bytes in the buffer at the specified start index match the expected boundary string. </summary> <param name="lineEndStartPosition">The start of the line resource set preceding the boundary (if present).</param> <param name="boundaryDelimiterStartPosition">The start position of the boundary delimiter.</param> <param name="boundary">The boundary string to check for.</param> <param name="boundaryStartPosition">If a match is detected, the start of the boundary delimiter, i.e., either the start of the leading line resource set or of the leading dashes.</param> <param name="boundaryEndPosition">If a match is detected, the position of the boundary end; otherwise -1.</param> <param name="isEndBoundary">true if the detected boundary is an end boundary; otherwise false.</param> <returns>An <see cref="T:Microsoft.OData.ODataBatchReaderStreamScanResult"/> indicating whether a match, a partial match or no match was found.</returns> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.MatchBoundary(System.String,System.Int32,System.Int32,System.Boolean@)"> <summary> Try to match the specified boundary string starting at the specified position. </summary> <param name="boundary">The boundary string to search for; this does not include the leading line terminator or the leading dashes.</param> <param name="startIx">The index at which to start matching the boundary.</param> <param name="matchLength">The number of characters to match.</param> <param name="isEndBoundary">true if the boundary string is used in an end boundary; otherwise false.</param> <returns>true if it was established that the buffer starting at <paramref name="startIx"/> matches the <paramref name="boundary"/>; otherwise false.</returns> <remarks>This method also returns false if the boundary string was completely matched against the buffer but it could not be determined whether it is used in an end boundary or not.</remarks> </member> <member name="M:Microsoft.OData.ODataBatchReaderStreamBuffer.ShiftToBeginning(System.Int32)"> <summary> Shifts all bytes in the buffer after a specified start index to the beginning of the buffer. </summary> <param name="startIndex">The start index where to start shifting.</param> </member> <member name="T:Microsoft.OData.ODataBatchReaderStreamScanResult"> <summary> An enumeration representing the result of a scan operation through the batch reader stream's buffer. </summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamScanResult.NoMatch"> <summary>No match with the requested boundary was found (not even a partial one).</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamScanResult.PartialMatch"> <summary>A partial match with the requested boundary was found.</summary> </member> <member name="F:Microsoft.OData.ODataBatchReaderStreamScanResult.Match"> <summary>A complete match with the requested boundary was found.</summary> <remarks> This is only returned if we could also check whether the boundary is an end boundary or not; otherwise a partial match is returned. </remarks> </member> <member name="T:Microsoft.OData.ODataBatchUtils"> <summary> Helper methods used by the ODataBatchWriter and ODataBatchReader (and related classes). </summary> </member> <member name="M:Microsoft.OData.ODataBatchUtils.CreateOperationRequestUri(System.Uri,System.Uri,Microsoft.OData.IODataPayloadUriConverter)"> <summary> Creates the URI for a batch request operation. </summary> <param name="uri">The uri to process.</param> <param name="baseUri">The base Uri to use.</param> <param name="payloadUriConverter">An optional custom URL converter to convert URLs for writing them into the payload.</param> <returns>An URI to be used in the request line of a batch request operation. It uses the <paramref name="payloadUriConverter"/> first and falls back to the default URI building schema if the no URL resolver is specified or the URL resolver returns null. In the default scheme, the method either returns the specified <paramref name="uri"/> if it was absolute, or it's combination with the <paramref name="baseUri"/> if it was relative.</returns> <remarks> This method will fail if no custom resolution is implemented and the specified <paramref name="uri"/> is relative and there's no base URI available. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchUtils.CreateBatchOperationReadStream(Microsoft.OData.ODataBatchReaderStream,Microsoft.OData.ODataBatchOperationHeaders,Microsoft.OData.IODataStreamListener,System.Boolean)"> <summary> Creates a batch operation stream from the specified batch stream. </summary> <param name="batchReaderStream">The batch stream to create the operation read stream for.</param> <param name="headers">The headers of the current part; based on the header we create different, optimized stream implementations.</param> <param name="operationListener">The operation listener to be passed to the newly created read stream.</param> <param name="synchronous">true if the stream is to be created for synchronous operation; false for asynchronous.</param> <returns>A new <see cref="T:Microsoft.OData.ODataReadStream"/> instance.</returns> </member> <member name="M:Microsoft.OData.ODataBatchUtils.CreateBatchOperationWriteStream(System.IO.Stream,Microsoft.OData.IODataStreamListener,System.Boolean)"> <summary> Creates a batch operation write stream over the specified output stream. </summary> <param name="outputStream">The output stream to create the operation write stream over.</param> <param name="operationListener">The operation listener to be passed to the newly created write stream.</param> <param name="synchronous">true if the stream is to be created for synchronous operation; false for asynchronous.</param> <returns>A new <see cref="T:Microsoft.OData.ODataWriteStream"/> instance.</returns> </member> <member name="M:Microsoft.OData.ODataBatchUtils.EnsureArraySize(System.Byte[]@,System.Int32,System.Int32)"> <summary> Grows the specified byte array by the specified amount. </summary> <param name="buffer">The byte array to grow.</param> <param name="numberOfBytesInBuffer">The number of bytes currently in the buffer.</param> <param name="requiredByteCount">The number of bytes to be added to the array.</param> </member> <member name="M:Microsoft.OData.ODataBatchUtils.ValidateReferenceUri(System.Uri,System.Collections.Generic.IEnumerable{System.String},System.Uri)"> <summary> Validates that the URIs reference of $requestId, if used, is one of the depends-on requests. The Uri can be either absolute or relative. Exception is thrown if the request Id reference is not found in the list of depends-on requests. </summary> <param name="uri">The Uri to validate the request Id reference.</param> <param name="dependsOnRequestIds">Enumeration of request Ids used to lookup the request Id reference.</param> <param name="baseUri">The baseUri used for validation.</param> </member> <member name="T:Microsoft.OData.ODataBatchWriter"> <summary> Abstract class for writing OData batch messages; also verifies the proper sequence of write calls on the writer. </summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.outputContext"> <summary>The output context to write to.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.container"> <summary>The dependency injection container to get related services.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.state"> <summary>The state the writer currently is in.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.currentOperationRequestMessage"> <summary>The request message for the operation that is currently written if it's a request; or null if no part is written right now or it's a response part.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.currentOperationResponseMessage"> <summary>The response message for the operation that is currently written if it's a response; or null if no part is written right now or it's a request part.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.currentOperationContentId"> <summary> The value of the Content-ID header of the current operation (or null if no Content-ID header exists). </summary> <remarks> Note that the current Content-ID header is not included immediately in the content ID cache since the current content ID will only be visible to subsequent operations. </remarks> </member> <member name="F:Microsoft.OData.ODataBatchWriter.currentBatchSize"> <summary>The current size of the batch message, i.e., how many query operations and changesets have been written.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.currentChangeSetSize"> <summary>The current size of the active changeset, i.e., how many request have been written for the changeset.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.isInChangeset"> <summary> Whether the writer is currently processing inside a changeset or atomic group. </summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.payloadUriConverter"> <summary>The batch-specific URL converter that stores the content IDs found in a changeset and supports resolving cross-referencing URLs.</summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.#ctor(Microsoft.OData.ODataOutputContext)"> <summary> Constructor. </summary> <param name="outputContext">The output context to write to.</param> </member> <member name="T:Microsoft.OData.ODataBatchWriter.BatchWriterState"> <summary> An enumeration representing the current state of the writer. </summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.Start"> <summary>The writer is in initial state; nothing has been written yet.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.BatchStarted"> <summary>WriteStartBatch has been called.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.ChangesetStarted"> <summary>WriteStartChangeSet has been called.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.OperationCreated"> <summary>CreateOperationRequestMessage/CreateOperationResponseMessage has been called.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.OperationStreamRequested"> <summary> ODataMessage.GetStreamAsync() has been called on an operation which caused a <see cref="T:Microsoft.OData.ODataStream"/> to be created; the batch writer is unusable while an operation is being written. </summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.OperationStreamDisposed"> <summary>The stream for writing the content of an operation has been disposed. The batch writer can now be used again.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.ChangesetCompleted"> <summary>WriteEndChangeSet has been called.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.BatchCompleted"> <summary>WriteEndBatch has been called.</summary> </member> <member name="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.Error"> <summary>The writer is in error state; nothing can be written anymore except the error payload.</summary> </member> <member name="P:Microsoft.OData.ODataBatchWriter.CurrentOperationRequestMessage"> <summary>The request message for the operation that is currently written if it's a request; or null if no operation is written right now or it's a response operation.</summary> </member> <member name="P:Microsoft.OData.ODataBatchWriter.CurrentOperationResponseMessage"> <summary>The response message for the operation that is currently written if it's a response; or null if no operation is written right now or it's a request operation.</summary> </member> <member name="P:Microsoft.OData.ODataBatchWriter.OutputContext"> <summary> The output context to write to. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartBatch"> <summary>Starts a new batch; can be only called once and as first call.</summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartBatchAsync"> <summary>Asynchronously starts a new batch; can be only called once and as first call.</summary> <returns>A task instance that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndBatch"> <summary>Ends a batch; can only be called after WriteStartBatch has been called and if no other active changeset or operation exist.</summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndBatchAsync"> <summary>Asynchronously ends a batch; can only be called after WriteStartBatch has been called and if no other active change set or operation exist.</summary> <returns>A task instance that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangeset"> <summary> Starts a new changeset without specifying group id. This can only be called after WriteStartBatch and if no other active operation or changeset exists. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangeset(System.String)"> <summary> Starts a new atomic group or changeset with the specified group id or changeset GUID corresponding to change set boundary. This can only be called after WriteStartBatch and if no other active operation or changeset exists.</summary> <param name="changesetId"> The change set Id of the batch request. Cannot be null.</param> <exception cref="T:Microsoft.OData.ODataException">Thrown if the <paramref name="changesetId"/> is null.</exception> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangesetAsync"> <summary>Asynchronously starts a new change set without specifying group id; This can only be called after WriteStartBatch and if no other active operation or change set exists.</summary> <returns>A task instance that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangesetAsync(System.String)"> <summary> Asynchronously starts a new change set; can only be called after WriteStartBatch and if no other active operation or change set exists. </summary> <param name="changesetId"> The change set Id of the batch request. Cannot be null.</param> <returns>A task instance that represents the asynchronous write operation.</returns> <exception cref="T:Microsoft.OData.ODataException">Thrown if the <paramref name="changesetId"/> is null.</exception> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndChangeset"> <summary>Ends an active changeset; this can only be called after WriteStartChangeset and only once for each changeset.</summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndChangesetAsync"> <summary>Asynchronously ends an active change set; this can only be called after WriteStartChangeset and only once for each change set.</summary> <returns>A task instance that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessage(System.String,System.Uri,System.String)"> <summary>Creates an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for writing an operation of a batch request.</summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId">The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <returns>The message that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessage(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption)"> <summary>Creates an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for writing an operation of a batch request.</summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId">The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <returns>The message that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessage(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IEnumerable{System.String})"> <summary> Creates an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for writing an operation of a batch request. </summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId"> The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>The message that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageAsync(System.String,System.Uri,System.String)"> <summary>Creates a message for asynchronously writing an operation of a batch request.</summary> <returns>The message that can be used to asynchronously write the request operation.</returns> <param name="method">The HTTP method to be used for this request operation.</param> <param name="uri">The URI to be used for this request operation.</param> <param name="contentId"> The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <returns>A task that when completed returns the newly created operation request message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageAsync(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption)"> <summary>Creates a message for asynchronously writing an operation of a batch request.</summary> <returns>The message that can be used to asynchronously write the request operation.</returns> <param name="method">The HTTP method to be used for this request operation.</param> <param name="uri">The URI to be used for this request operation.</param> <param name="contentId"> The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <returns>A task that when completed returns the newly created operation request message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageAsync(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IList{System.String})"> <summary> Creates a message for asynchronously writing an operation of a batch request.</summary> <returns>The message that can be used to asynchronously write the request operation.</returns> <param name="method">The HTTP method to be used for this request operation.</param> <param name="uri">The URI to be used for this request operation.</param> <param name="contentId"> The Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET".</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>A task that when completed returns the newly created operation request message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationResponseMessage(System.String)"> <summary>Creates a message for writing an operation of a batch response.</summary> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <returns>The message that can be used to write the response operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationResponseMessageAsync(System.String)"> <summary>Asynchronously creates an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage" /> for writing an operation of a batch response.</summary> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <returns>A task that when completed returns the newly created operation response message.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.Flush"> <summary>Flushes the write buffer to the underlying stream.</summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.FlushAsync"> <summary>Flushes the write buffer to the underlying stream asynchronously.</summary> <returns>A task instance that represents the asynchronous operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.StreamRequested"> <summary> This method is called to notify that the content stream for a batch operation has been requested. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.StreamRequestedAsync"> <summary> This method is called to notify that the content stream for a batch operation has been requested. </summary> <returns> A task representing any action that is running as part of the status change of the operation; null if no such action exists. </returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.StreamDisposed"> <summary> This method is called to notify that the content stream of a batch operation has been disposed. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.StreamDisposedAsync"> <summary> This method is called asynchronously to notify that the content stream of a batch operation has been disposed. </summary> <returns>A task that represents the asynchronous operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.OnInStreamError"> <summary> This method notifies the listener, that an in-stream error is to be written. </summary> <remarks> This listener can choose to fail, if the currently written payload doesn't support in-stream error at this position. If the listener returns, the writer should not allow any more writing, since the in-stream error is the last thing in the payload. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchWriter.OnInStreamErrorAsync"> <inheritdoc/> </member> <member name="M:Microsoft.OData.ODataBatchWriter.FlushSynchronously"> <summary> Flush the output. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.FlushAsynchronously"> <summary> Flush the output. </summary> <returns>Task representing the pending flush operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndBatchImplementation"> <summary> Ends a batch. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangesetImplementation(System.String)"> <summary> Starts a new changeset. </summary> <param name="groupOrChangesetId"> The atomic group id, aka changeset GUID of the batch request. </param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndChangesetImplementation"> <summary> Ends an active changeset. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationResponseMessageImplementation(System.String)"> <summary> Creates an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> for writing an operation of a batch response. </summary> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <returns>The message that can be used to write the response operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageImplementation(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IEnumerable{System.String})"> <summary> Creates an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> for writing an operation of a batch request. </summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>The message that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.SetState(Microsoft.OData.ODataBatchWriter.BatchWriterState)"> <summary> Sets a new writer state; verifies that the transition from the current state into new state is valid. </summary> <param name="newState">The writer state to transition into.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyNotDisposed"> <summary> Verifies that the writer is not disposed. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartBatchImplementation"> <summary> Starts a new batch. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.GetDependsOnRequestIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Given an enumerable of dependsOn ids containing request ids and group ids, return an enumeration of equivalent request ids. </summary> <param name="dependsOnIds">The dependsOn ids specifying current request's prerequisites.</param> <returns>An enumerable consists of request ids.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.ValidateDependsOnIds(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Validate the dependsOnIds. </summary> <param name="contentId">The request Id</param> <param name="dependsOnIds">The dependsOn ids specifying current request's prerequisites.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.BuildOperationRequestMessage(System.IO.Stream,System.String,System.Uri,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Wrapper method to create an operation request message that can be used to write the operation content to, utilizing private members <see cref="T:Microsoft.OData.ODataBatchPayloadUriConverter"/> and <see cref="T:System.IServiceProvider"/>. </summary> <param name="outputStream">The output stream underlying the operation message.</param> <param name="method">The HTTP method to use for the message to create.</param> <param name="uri">The request URL for the message to create.</param> <param name="contentId">The contentId of this request message.</param> <param name="groupId">The group id that this request belongs to. Can be null.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>An <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> to write the request content to.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.BuildOperationResponseMessage(System.IO.Stream,System.String,System.String)"> <summary> Wrapper method to create an operation response message that can be used to write the operation content to, utilizing private members <see cref="T:Microsoft.OData.ODataBatchPayloadUriConverter"/> and <see cref="T:System.IServiceProvider"/>. </summary> <param name="outputStream">The output stream underlying the operation message.</param> <param name="contentId">The contentId of this response message.</param> <param name="groupId">The group id of the response message, should be the same as the group id in the corresponding request message.</param> <returns>An <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> that can be used to write the operation content.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartBatchImplementationAsync"> <summary> Asnchronously starts a new batch. </summary> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndBatchImplementationAsync"> <summary> Asynchronously ends a batch. </summary> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteStartChangesetImplementationAsync(System.String)"> <summary> Asynchronously starts a new changeset. </summary> <param name="groupOrChangesetId">The atomic group id, aka changeset GUID of the batch request.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.WriteEndChangesetImplementationAsync"> <summary> Asynchronously ends an active changeset. </summary> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageImplementationAsync(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IEnumerable{System.String})"> <summary> Asynchronously creates an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> for writing an operation of a batch request. </summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>A task that represents the asynchronous operation. The value of the TResult parameter contains an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationResponseMessageImplementationAsync(System.String)"> <summary> Asynchronously creates an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> for writing an operation of a batch response. </summary> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> <returns>A task that represents the asynchronous operation. The value of the TResult parameter contains an <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> that can be used to write the response operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.InterceptException(System.Action{Microsoft.OData.ODataBatchWriter})"> <summary> Catch any exception thrown by the action passed in; in the exception case move the writer into state Error and then re-throw the exception. </summary> <param name="action">The action to execute.</param> <remarks> Make sure to only use anonymous functions that don't capture state from the enclosing context, so the compiler optimizes the code to avoid delegate and closure allocations on every call to this method. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchWriter.InterceptException``1(System.Action{Microsoft.OData.ODataBatchWriter,``0},``0)"> <summary> Catch any exception thrown by the action passed in; in the exception case move the writer into state Error and then rethrow the exception. </summary> <typeparam name="TArg0">The action argument type.</typeparam> <param name="action">The action to execute.</param> <param name="arg0">The argument value provided to the action.</param> <remarks> Make sure to only use anonymous functions that don't capture state from the enclosing context, so the compiler optimizes the code to avoid delegate and closure allocations on every call to this method. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchWriter.InterceptException``2(System.Func{Microsoft.OData.ODataBatchWriter,``1,``0},``1)"> <summary> Catch any exception thrown by the action passed in; in the exception case move the writer into state Error and then rethrow the exception. </summary> <typeparam name="TResult">The type of the result returned by the operation.</typeparam> <typeparam name="TArg">The action argument type.</typeparam> <param name="operation">The action to execute.</param> <param name="arg">The argument value provided to the action.</param> <returns>The result if the operation succeeds; otherwise the writer state is set to <see cref="F:Microsoft.OData.ODataBatchWriter.BatchWriterState.Error"/> and the exception rethrown. </returns> <remarks> Make sure to only use anonymous functions that don't capture state from the enclosing context, so the compiler optimizes the code to avoid delegate and closure allocations on every call to this method. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchWriter.InterceptExceptionAsync(System.Func{Microsoft.OData.ODataBatchWriter,System.Threading.Tasks.Task})"> <summary> Catch any exception thrown by the action passed in; in the exception case move the reader into state Error and then rethrow the exception. </summary> <param name="action">The action to execute.</param> <returns>A task that represents the asynchronous operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.ThrowODataException(System.String)"> <summary> Sets the 'Error' state and then throws an ODataException with the specified error message. </summary> <param name="errorMessage">The error message for the exception.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageInternal(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IEnumerable{System.String})"> <summary> Internal method to create an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for writing an operation of a batch request. </summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId"> For batch in multipart format, the Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET". For batch in Json format, if the value passed in is null, an GUID will be generated and used as the request id. </param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>The message that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.CreateOperationRequestMessageInternalAsync(System.String,System.Uri,System.String,Microsoft.OData.BatchPayloadUriOption,System.Collections.Generic.IEnumerable{System.String})"> <summary> Internal method to create an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage" /> for writing an operation of a batch request. </summary> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId"> For batch in multipart format, the Content-ID value to write in ChangeSet header, would be ignored if <paramref name="method"/> is "GET". For batch in Json format, if the value passed in is null, an GUID will be generated and used as the request id. </param> <param name="payloadUriOption"> The format of operation Request-URI, which could be AbsoluteUri, AbsoluteResourcePathAndHost, or RelativeResourcePath.</param> <param name="dependsOnIds">The prerequisite request ids of this request.</param> <returns>A task that represents the asynchronous operation. The value of the TResult parameter contains an <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> that can be used to write the request operation.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.FinishWriteStartChangeset"> <summary> Perform updates after changeset is started. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.FinishWriteEndChangeset"> <summary> Perform updates after changeset is ended. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.RememberContentIdHeader(System.String)"> <summary> Remember a non-null Content-ID header for change set request operations. If a non-null content ID header is specified for a change set request operation, record it in the URL resolver. </summary> <param name="contentId">The Content-ID header value read from the message.</param> <remarks> Note that the content ID of this operation will only become visible once this operation has been written and OperationCompleted has been called on the URL resolver. </remarks> </member> <member name="M:Microsoft.OData.ODataBatchWriter.IncreaseBatchSize"> <summary> Increases the size of the current batch message; throws if the allowed limit is exceeded. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.IncreaseChangeSetSize"> <summary> Increases the size of the current change set; throws if the allowed limit is exceeded. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.ResetChangeSetSize"> <summary> Resets the size of the current change set to 0. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCallAllowed(System.Boolean)"> <summary> Verifies that a call is allowed to the writer. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanCreateOperationRequestMessage(System.Boolean,System.String,System.Uri,System.String)"> <summary> Verifies that calling CreateOperationRequestMessage is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> <param name="method">The Http method to be used for this request operation.</param> <param name="uri">The Uri to be used for this request operation.</param> <param name="contentId">The Content-ID value to write in ChangeSet head.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanFlush(System.Boolean)"> <summary> Verifies that the writer is in correct state for the Flush operation. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.ValidateWriterReady"> <summary> Validates that the batch writer is ready to process a new write request. </summary> </member> <member name="M:Microsoft.OData.ODataBatchWriter.IsErrorState(Microsoft.OData.ODataBatchWriter.BatchWriterState)"> <summary> Determines whether a given writer state is considered an error state. </summary> <param name="state">The writer state to check.</param> <returns>True if the writer state is an error state; otherwise false.</returns> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanWriteStartBatch(System.Boolean)"> <summary> Verifies that calling WriteStartBatch is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanWriteEndBatch(System.Boolean)"> <summary> Verifies that calling WriteEndBatch is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanWriteStartChangeset(System.Boolean)"> <summary> Verifies that calling WriteStartChangeset is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanWriteEndChangeset(System.Boolean)"> <summary> Verifies that calling WriteEndChangeset is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.VerifyCanCreateOperationResponseMessage(System.Boolean)"> <summary> Verifies that calling CreateOperationResponseMessage is valid. </summary> <param name="synchronousCall">true if the call is to be synchronous; false otherwise.</param> </member> <member name="M:Microsoft.OData.ODataBatchWriter.ValidateTransition(Microsoft.OData.ODataBatchWriter.BatchWriterState)"> <summary> Verifies that the transition from the current state into new state is valid . </summary> <param name="newState">The new writer state to transition into.</param> </member> <member name="M:Microsoft.OData.BindingPathHelper.MatchBindingPath(Microsoft.OData.Edm.IEdmPathExpression,System.Collections.Generic.IReadOnlyList{Microsoft.OData.UriParser.ODataPathSegment})"> <summary> Determine if the path of current navigation property is matching the binding path. The function used in FindNavigationTarget to resolve the navigation target for multi binding. </summary> <param name="bindingPath">The binding path.</param> <param name="parsedSegments">The list of segments in Uri path.</param> <returns>True if the path of navigation property in current scope is matching the <paramref name="bindingPath"/>.</returns> </member> <member name="T:Microsoft.OData.BufferedReadStream"> <summary> Class which takes an input stream, buffers the entire content asynchronously and exposes it as a stream which can be read synchronously. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.buffers"> <summary> List of buffers which store the data. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.inputStream"> <summary> The input stream to read from. This is used only during the buffering and is set to null once we've buffered everything. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.currentBufferIndex"> <summary> Points to the buffer currently being processed. When writing into the buffers this points to the last buffer to which the bytes should be written. When reading from the buffers this points to the buffer from which we are currently reading. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.currentBufferReadCount"> <summary> Number of bytes read from the current buffer. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.#ctor(System.IO.Stream)"> <summary> Private constructor. </summary> <param name="inputStream">The stream to read from.</param> </member> <member name="P:Microsoft.OData.BufferedReadStream.CanRead"> <summary> Determines if the stream can read - this one can </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.CanSeek"> <summary> Determines if the stream can seek - this one cannot </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.CanWrite"> <summary> Determines if the stream can write - this one cannot </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.Length"> <summary> Returns the length of the stream, which this implementation doesn't support. </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.Position"> <summary> Gets or sets the position in the stream, this stream doesn't support seeking, so position is also unsupported. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.Flush"> <summary> Flush the stream to the underlying storage. This operation is not supported by this stream. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.Read(System.Byte[],System.Int32,System.Int32)"> <summary> Reads data from the stream. </summary> <param name="buffer">The buffer to read the data to.</param> <param name="offset">The offset in the buffer to write to.</param> <param name="count">The number of bytes to read.</param> <returns>The number of bytes actually read.</returns> </member> <member name="M:Microsoft.OData.BufferedReadStream.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Seeks the stream. This operation is not supported by this stream. </summary> <param name="offset">The offset to seek to.</param> <param name="origin">The origin of the seek operation.</param> <returns>The new position in the stream.</returns> </member> <member name="M:Microsoft.OData.BufferedReadStream.SetLength(System.Int64)"> <summary> Sets the length of the stream. This operation is not supported by this stream. </summary> <param name="value">The length in bytes to set.</param> </member> <member name="M:Microsoft.OData.BufferedReadStream.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes to the stream. This operation is not supported by this stream. </summary> <param name="buffer">The buffer to get data from.</param> <param name="offset">The offset in the buffer to start from.</param> <param name="count">The number of bytes to write.</param> </member> <member name="M:Microsoft.OData.BufferedReadStream.BufferStreamAsync(System.IO.Stream)"> <summary> Given the <paramref name="inputStream"/> this method returns a task which will asynchronously read the entire content of that stream and return a new synchronous stream from which the data can be read. </summary> <param name="inputStream">The input stream to asynchronously buffer.</param> <returns>A task which returns the buffered stream.</returns> </member> <member name="M:Microsoft.OData.BufferedReadStream.ResetForReading"> <summary> Resets the stream to the beginning and prepares it for reading. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.BufferInputStream"> <summary> Returns enumeration of tasks to run to buffer the entire input stream. </summary> <returns>Enumeration of tasks to run to buffer the input stream.</returns> <remarks>This method relies on lazy eval of the enumerator, never enumerate through it synchronously.</remarks> </member> <member name="M:Microsoft.OData.BufferedReadStream.AddNewBuffer"> <summary> Adds a new buffer to the list and makes it the current buffer. </summary> <returns>The newly added buffer.</returns> </member> <member name="T:Microsoft.OData.BufferedReadStream.DataBuffer"> <summary> Class to wrap a byte buffer used to store portion of the buffered data. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.DataBuffer.MinReadBufferSize"> <summary> The minimum size to ask for when reading from underlying stream. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.DataBuffer.BufferSize"> <summary> The size of a buffer to allocate - use 64KB to be aligned which makes it likely that the underlying levels will be able to process the request in one go. </summary> </member> <member name="F:Microsoft.OData.BufferedReadStream.DataBuffer.buffer"> <summary> The byte buffer which stored the data. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.DataBuffer.#ctor"> <summary> Constructor - creates a new buffer; </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.DataBuffer.Buffer"> <summary> The byte buffer. </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.DataBuffer.OffsetToWriteTo"> <summary> The offset into the buffer to which more data can be written. </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.DataBuffer.StoredCount"> <summary> The number of bytes stored in the buffer. </summary> </member> <member name="P:Microsoft.OData.BufferedReadStream.DataBuffer.FreeBytes"> <summary> The number of bytes not yet used in the buffer. </summary> </member> <member name="M:Microsoft.OData.BufferedReadStream.DataBuffer.MarkBytesAsWritten(System.Int32)"> <summary> Marks specified count of bytes as written starting at the OffsetToWriteTo. </summary> <param name="count">The number of bytes to mark as written.</param> </member> <member name="T:Microsoft.OData.BufferingReadStream"> <summary> Read-only stream which initially buffers all read data in order to replay it later. Once no more buffered data exists it reads from the underlying stream directly. </summary> </member> <member name="F:Microsoft.OData.BufferingReadStream.buffers"> <summary>The list of buffered chunks of bytes as requested by callers.</summary> </member> <member name="F:Microsoft.OData.BufferingReadStream.innerStream"> <summary> The stream being wrapped. </summary> </member> <member name="F:Microsoft.OData.BufferingReadStream.positionInCurrentBuffer"> <summary>The read position in the current buffer.</summary> </member> <member name="F:Microsoft.OData.BufferingReadStream.bufferingModeDisabled"> <summary> true if the reader is not in buffering mode; otherwise false. </summary> </member> <member name="F:Microsoft.OData.BufferingReadStream.currentReadNode"> <summary> The current node in the buffer list to read from. </summary> </member> <member name="M:Microsoft.OData.BufferingReadStream.#ctor(System.IO.Stream)"> <summary> Constructor </summary> <param name="stream">The underlying stream to wrap. Note that only read operations will be invoked on this stream.</param> </member> <member name="P:Microsoft.OData.BufferingReadStream.CanRead"> <summary> Determines if the stream can read - this one can. </summary> </member> <member name="P:Microsoft.OData.BufferingReadStream.CanSeek"> <summary> Determines if the stream can seek - this one cannot </summary> </member> <member name="P:Microsoft.OData.BufferingReadStream.CanWrite"> <summary> Determines if the stream can write - this one cannot </summary> </member> <member name="P:Microsoft.OData.BufferingReadStream.Length"> <summary> Returns the length of the stream, which this implementation doesn't support. </summary> </member> <member name="P:Microsoft.OData.BufferingReadStream.Position"> <summary> Gets or sets the position in the stream, this stream doesn't support seeking, so position is also unsupported. </summary> </member> <member name="P:Microsoft.OData.BufferingReadStream.IsBuffering"> <summary> true if the stream is in buffering mode; otherwise false. </summary> </member> <member name="M:Microsoft.OData.BufferingReadStream.Flush"> <summary> Not supported since the stream only allows reading. </summary> </member> <member name="M:Microsoft.OData.BufferingReadStream.Read(System.Byte[],System.Int32,System.Int32)"> <summary> Reads data from the buffer or the underlying stream. </summary> <param name="userBuffer">The buffer to read the data to.</param> <param name="offset">The offset in the buffer to write to.</param> <param name="count">The number of bytes to read.</param> <returns>The number of bytes actually read.</returns> </member> <member name="M:Microsoft.OData.BufferingReadStream.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Seeks the stream. This operation is not supported by this stream. </summary> <param name="offset">The offset to seek to.</param> <param name="origin">The origin of the seek operation.</param> <returns>The new position in the stream.</returns> </member> <member name="M:Microsoft.OData.BufferingReadStream.SetLength(System.Int64)"> <summary> Sets the length of the stream. This operation is not supported by this stream. </summary> <param name="value">The length in bytes to set.</param> </member> <member name="M:Microsoft.OData.BufferingReadStream.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes to the stream. This operation is not supported by this stream. </summary> <param name="buffer">The buffer to get data from.</param> <param name="offset">The offset in the buffer to start from.</param> <param name="count">The number of bytes to write.</param> </member> <member name="M:Microsoft.OData.BufferingReadStream.ResetStream"> <summary> Stops the buffering mode and turns the reader into normal read mode where first the buffered data is re-read before the reads are performed on the underlying stream. </summary> </member> <member name="M:Microsoft.OData.BufferingReadStream.StopBuffering"> <summary> Stop buffering. </summary> </member> <member name="M:Microsoft.OData.BufferingReadStream.Dispose(System.Boolean)"> <summary> Disposes the object. </summary> <param name="disposing">True if called from Dispose; false if called from the finalizer.</param> </member> <member name="M:Microsoft.OData.BufferingReadStream.MoveToNextBuffer"> <summary> Moves the reader to the next buffer and drops already consumed data if not in buffering mode. </summary> </member> <member name="T:Microsoft.OData.Buffers.BufferUtils"> <summary> Helpers to deal with buffers </summary> </member> <member name="F:Microsoft.OData.Buffers.BufferUtils.BufferLength"> <summary> Buffer length </summary> </member> <member name="M:Microsoft.OData.Buffers.BufferUtils.InitializeBufferIfRequired(System.Char[])"> <summary> Checks if the buffer is not initialized and if initialized returns the same buffer or creates a new one. </summary> <param name="buffer">The buffer to verify</param> <returns>The initialized buffer</returns> </member> <member name="M:Microsoft.OData.Buffers.BufferUtils.InitializeBufferIfRequired(Microsoft.OData.Buffers.ICharArrayPool,System.Char[])"> <summary> Checks if the buffer is not initialized and if initialized returns the same buffer or creates a new one. </summary> <param name="bufferPool">The character pool.</param> <param name="buffer">The buffer to verify</param> <returns>The initialized buffer.</returns> </member> <member name="M:Microsoft.OData.Buffers.BufferUtils.RentFromBuffer(Microsoft.OData.Buffers.ICharArrayPool,System.Int32)"> <summary> Rents a character array from the pool. </summary> <param name="bufferPool">The character pool.</param> <param name="minSize">The min required size of the character array.</param> <returns>The character array from the pool.</returns> </member> <member name="M:Microsoft.OData.Buffers.BufferUtils.ReturnToBuffer(Microsoft.OData.Buffers.ICharArrayPool,System.Char[])"> <summary> Returns a character array to the pool. </summary> <param name="bufferPool">The character pool.</param> <param name="buffer">The character array should be returned.</param> </member> <member name="T:Microsoft.OData.Buffers.ICharArrayPool"> <summary> Provides an interface for using character arrays. </summary> </member> <member name="M:Microsoft.OData.Buffers.ICharArrayPool.Rent(System.Int32)"> <summary> Rents a character array from the pool. This character array must be returned when it is no longer used. </summary> <param name="minSize">The min required size of the character array.</param> <returns>The character array from the pool.</returns> </member> <member name="M:Microsoft.OData.Buffers.ICharArrayPool.Return(System.Char[])"> <summary> Returns a character array to the pool. </summary> <param name="array">The character array should be returned.</param> </member> <member name="T:Microsoft.OData.CollectionWithoutExpectedTypeValidator"> <summary> Helper class to verify that all items of a collection are of the same kind and type. </summary> <remarks>This class is only used if no expected item type is specified for the collection; otherwise all items are already validated against the expected item type.</remarks> </member> <member name="F:Microsoft.OData.CollectionWithoutExpectedTypeValidator.itemTypeDerivedFromCollectionValue"> <summary>true if the item type was derived from the collection value; otherwise false.</summary> </member> <member name="F:Microsoft.OData.CollectionWithoutExpectedTypeValidator.itemTypeName"> <summary>The item type name extracted from the first non-null item.</summary> </member> <member name="F:Microsoft.OData.CollectionWithoutExpectedTypeValidator.primitiveItemType"> <summary> The primitive type denoted by the item type name or null if the type name is not a valid primitive type name. </summary> </member> <member name="F:Microsoft.OData.CollectionWithoutExpectedTypeValidator.itemTypeKind"> <summary>The item type kind from the first non-null item.</summary> </member> <member name="M:Microsoft.OData.CollectionWithoutExpectedTypeValidator.#ctor(System.String)"> <summary> Constructor. </summary> <param name="itemTypeNameFromCollection">The item type name extracted from the collection type name.</param> </member> <member name="P:Microsoft.OData.CollectionWithoutExpectedTypeValidator.ItemTypeNameFromCollection"> <summary> If specified on a collection, returns the item type name that all items are expected to be compatible with; otherwise null. </summary> </member> <member name="P:Microsoft.OData.CollectionWithoutExpectedTypeValidator.ItemTypeKindFromCollection"> <summary> If specified on a collection, returns the item type kind that all items are expected to be compatible with; otherwise EdmTypeKind.None. </summary> </member> <member name="M:Microsoft.OData.CollectionWithoutExpectedTypeValidator.ValidateCollectionItem(System.String,Microsoft.OData.Edm.EdmTypeKind)"> <summary> Validates a collection item that was read to make sure it is valid (i.e., has the correct type name and type kind) with respect to the other items in the collection. </summary> <param name="collectionItemTypeName">The type name of the item from the payload.</param> <param name="collectionItemTypeKind">The type kind of the item from the payload.</param> </member> <member name="M:Microsoft.OData.CollectionWithoutExpectedTypeValidator.ComputeExpectedTypeKind(System.String,Microsoft.OData.Edm.IEdmPrimitiveType@)"> <summary> Computes the expected type kind of an item from the type name read from the payload. </summary> <param name="typeName">The type name to compute the type kind from.</param> <param name="primitiveItemType">The primitive type for the specified type name or null if the type name is not a valid primitive type.</param> <returns>The <see cref="T:Microsoft.OData.Edm.EdmTypeKind"/> of the type with the specified <paramref name="typeName"/>.</returns> </member> <member name="M:Microsoft.OData.CollectionWithoutExpectedTypeValidator.GetItemTypeFullName(System.String)"> <summary> Get the item type full name if it's the primitive type </summary> <param name="typeName">the original type name</param> <returns>the item type full name if it's the primitive type</returns> </member> <member name="M:Microsoft.OData.CollectionWithoutExpectedTypeValidator.ValidateCollectionItemTypeNameAndKind(System.String,Microsoft.OData.Edm.EdmTypeKind)"> <summary> Validate that the expected and actual type names and type kinds are compatible. </summary> <param name="collectionItemTypeName">The actual type name.</param> <param name="collectionItemTypeKind">The actual type kind.</param> </member> <member name="T:Microsoft.OData.ContainerBuilderExtensions"> <summary> Extension methods for <see cref="T:Microsoft.OData.IContainerBuilder"/>. </summary> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddService``2(Microsoft.OData.IContainerBuilder,Microsoft.OData.ServiceLifetime)"> <summary> Adds a service of <typeparamref name="TService"/> with an <typeparamref name="TImplementation"/>. </summary> <typeparam name="TService">The type of the service to add.</typeparam> <typeparam name="TImplementation">The type of the implementation to use.</typeparam> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the service to.</param> <param name="lifetime">The lifetime of the service to register.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddService(Microsoft.OData.IContainerBuilder,Microsoft.OData.ServiceLifetime,System.Type)"> <summary> Adds a service of <paramref name="serviceType"/>. </summary> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the service to.</param> <param name="lifetime">The lifetime of the service to register.</param> <param name="serviceType">The type of the service to register and the implementation to use.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddService``1(Microsoft.OData.IContainerBuilder,Microsoft.OData.ServiceLifetime)"> <summary> Adds a service of <typeparamref name="TService"/>. </summary> <typeparam name="TService">The type of the service to add.</typeparam> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the service to.</param> <param name="lifetime">The lifetime of the service to register.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddService``1(Microsoft.OData.IContainerBuilder,Microsoft.OData.ServiceLifetime,System.Func{System.IServiceProvider,``0})"> <summary> Adds a service of <typeparamref name="TService"/> with an <paramref name="implementationFactory"/>. </summary> <typeparam name="TService">The type of the service to add.</typeparam> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the service to.</param> <param name="lifetime">The lifetime of the service to register.</param> <param name="implementationFactory">The factory that creates the service.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddServicePrototype``1(Microsoft.OData.IContainerBuilder,``0)"> <summary> Adds a service prototype of type <typeparamref name="TService"/>. </summary> <typeparam name="TService">The type of the service prototype to add.</typeparam> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the service to.</param> <param name="instance">The service prototype to add.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddDefaultODataServices(Microsoft.OData.IContainerBuilder)"> <summary> Adds the default OData services to the <see cref="T:Microsoft.OData.IContainerBuilder"/>. </summary> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the services to.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.ContainerBuilderExtensions.AddDefaultODataServices(Microsoft.OData.IContainerBuilder,Microsoft.OData.ODataVersion)"> <summary> Adds the default OData services to the <see cref="T:Microsoft.OData.IContainerBuilder"/>. </summary> <param name="builder">The <see cref="T:Microsoft.OData.IContainerBuilder"/> to add the services to.</param> <param name="odataVersion">ODataVersion for the default services.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="T:Microsoft.OData.DerivedTypeValidator"> <summary> Helper class to verify the resource type meets the derived type constraints. </summary> </member> <member name="M:Microsoft.OData.DerivedTypeValidator.#ctor(Microsoft.OData.Edm.IEdmType,System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> Constructor. </summary> <param name="expectedType">The expected type.</param> <param name="derivedTypeConstraints">The derived type constraints.</param> <param name="resourceKind">The resource type, be used at error message.</param> <param name="resourceName">The resource name, be used at error message.</param> </member> <member name="M:Microsoft.OData.DerivedTypeValidator.ValidateResourceType(Microsoft.OData.Edm.IEdmType)"> <summary> Validates the type of a resource. </summary> <param name="resourceType">The type of the resource.</param> </member> <member name="M:Microsoft.OData.DerivedTypeValidator.ValidateResourceType(System.String)"> <summary> Validates the full type name of a resource. </summary> <param name="resourceTypeName">The full type name of the resource.</param> </member> <member name="T:Microsoft.OData.DuplicatePropertyNameChecker"> <summary> Validates that 1) No duplicate property. 2) No duplicate "@odata.associationLink" on a property. 3) "@odata.associationLink"s are put on navigation properties. </summary> </member> <member name="F:Microsoft.OData.DuplicatePropertyNameChecker.propertyState"> <summary> Caches property processing state. </summary> </member> <member name="T:Microsoft.OData.DuplicatePropertyNameChecker.State"> <summary> Property processing state. </summary> </member> <member name="F:Microsoft.OData.DuplicatePropertyNameChecker.State.NonNestedResource"> <summary> `ValidatePropertyUniqueness(ODataProperty)` has been called. </summary> </member> <member name="F:Microsoft.OData.DuplicatePropertyNameChecker.State.NestedResource"> <summary> `ValidatePropertyUniqueness(ODataNestedResourceInfo)` has been called. </summary> </member> <member name="F:Microsoft.OData.DuplicatePropertyNameChecker.State.AssociationLink"> <summary> `ValidatePropertyOpenForAssociationLink` has been called. </summary> </member> <member name="M:Microsoft.OData.DuplicatePropertyNameChecker.ValidatePropertyUniqueness(Microsoft.OData.ODataPropertyInfo)"> <summary> Validates property uniqueness. </summary> <param name="property">The property.</param> </member> <member name="M:Microsoft.OData.DuplicatePropertyNameChecker.ValidatePropertyUniqueness(Microsoft.OData.ODataNestedResourceInfo)"> <summary> Validates property uniqueness. </summary> <param name="property">The property.</param> </member> <member name="M:Microsoft.OData.DuplicatePropertyNameChecker.ValidatePropertyOpenForAssociationLink(System.String)"> <summary> Validates that "@odata.associationLink" is put on a navigation property, and that no duplicate exists. </summary> <param name="propertyName">Name of the property.</param> </member> <member name="M:Microsoft.OData.DuplicatePropertyNameChecker.Reset"> <summary> Resets to initial state for reuse. </summary> </member> <member name="T:Microsoft.OData.NullDuplicatePropertyNameChecker"> <summary> Mock version of `DuplicatePropertyNameChecker`, which does nothing. </summary> </member> <member name="F:Microsoft.OData.NullDuplicatePropertyNameChecker.Instance"> <summary> Singleton instance of the <see cref="T:Microsoft.OData.NullDuplicatePropertyNameChecker"/>. Since it does nothing, we can safely re-use the same instance throughout the process. </summary> </member> <member name="M:Microsoft.OData.EdmExtensionMethods.FindNavigationTarget(Microsoft.OData.Edm.IEdmNavigationSource,Microsoft.OData.Edm.IEdmNavigationProperty,System.Func{Microsoft.OData.Edm.IEdmPathExpression,System.Boolean})"> <summary> Find the navigation target which is <paramref name="navigationProperty"/> of current <paramref name="navigationSource"/> targets. </summary> <param name="navigationSource">The navigation source to find.</param> <param name="navigationProperty">The navigation property</param> <param name="matchBindingPath">The function used to determine if the binding path matches.</param> <returns>The navigation target which matches the binding path.</returns> </member> <member name="M:Microsoft.OData.EdmExtensionMethods.FindNavigationTarget(Microsoft.OData.Edm.IEdmNavigationSource,Microsoft.OData.Edm.IEdmNavigationProperty,System.Func{Microsoft.OData.Edm.IEdmPathExpression,System.Collections.Generic.IReadOnlyList{Microsoft.OData.UriParser.ODataPathSegment},System.Boolean},System.Collections.Generic.IReadOnlyList{Microsoft.OData.UriParser.ODataPathSegment},Microsoft.OData.Edm.IEdmPathExpression@)"> <summary> Find the navigation target which is <paramref name="navigationProperty"/> of current <paramref name="navigationSource"/> targets. The function is specifically used in Uri parser. </summary> <param name="navigationSource">The navigation source to find.</param> <param name="navigationProperty">The navigation property</param> <param name="matchBindingPath">The function used to determine if the binding path matches.</param> <param name="parsedSegments">The parsed segments in path, which is used to match binding path.</param> <param name="bindingPath">The output binding path of the navigation property which matches the <paramref name="parsedSegments"/></param> <returns>The navigation target which matches the binding path.</returns> </member> <member name="M:Microsoft.OData.EdmExtensionMethods.HasKey(Microsoft.OData.Edm.IEdmNavigationSource,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Decide whether <paramref name="currentNavigationSource"/> with type <paramref name="currentResourceType"/> should have key. </summary> <param name="currentNavigationSource">The navigation source to be evaluated.</param> <param name="currentResourceType">The resource type to be evaluated.</param> <returns>True if the navigation source should have key.</returns> </member> <member name="T:Microsoft.OData.ErrorUtils"> <summary> Utility methods serializing the xml error payload </summary> </member> <member name="F:Microsoft.OData.ErrorUtils.ODataErrorMessageDefaultLanguage"> <summary>Default language for error messages if not specified.</summary> <remarks> This constant is included here since this file is compiled into WCF DS Server as well so we can't compile in the ODataConstants. </remarks> </member> <member name="M:Microsoft.OData.ErrorUtils.GetErrorDetails(Microsoft.OData.ODataError,System.String@,System.String@)"> <summary> Extracts error details from an <see cref="T:Microsoft.OData.ODataError"/>. </summary> <param name="error">The ODataError instance to extract the error details from.</param> <param name="code">A data service-defined string which serves as a substatus to the HTTP response code.</param> <param name="message">A human readable message describing the error.</param> </member> <member name="M:Microsoft.OData.ErrorUtils.WriteXmlError(System.Xml.XmlWriter,Microsoft.OData.ODataError,System.Boolean,System.Int32)"> <summary> Write an error message. </summary> <param name="writer">The Xml writer to write to.</param> <param name="error">The error instance to write.</param> <param name="includeDebugInformation">A flag indicating whether error details should be written (in debug mode only) or not.</param> <param name="maxInnerErrorDepth">The maximum number of nested inner errors to allow.</param> </member> <member name="M:Microsoft.OData.ErrorUtils.WriteXmlError(System.Xml.XmlWriter,System.String,System.String,Microsoft.OData.ODataInnerError,System.Int32)"> <summary> Write an error message. </summary> <param name="writer">The Xml writer to write to.</param> <param name="code">The code of the error.</param> <param name="message">The message of the error.</param> <param name="innerError">Inner error details that will be included in debug mode (if present).</param> <param name="maxInnerErrorDepth">The maximum number of nested inner errors to allow.</param> </member> <member name="M:Microsoft.OData.ErrorUtils.WriteXmlInnerError(System.Xml.XmlWriter,Microsoft.OData.ODataInnerError,System.String,System.Int32,System.Int32)"> <summary> Writes the inner exception information in debug mode. </summary> <param name="writer">The Xml writer to write to.</param> <param name="innerError">The inner error to write.</param> <param name="innerErrorElementName">The local name of the element representing the inner error.</param> <param name="recursionDepth">The number of times this method has been called recursively.</param> <param name="maxInnerErrorDepth">The maximum number of nested inner errors to allow.</param> </member> <member name="T:Microsoft.OData.Evaluation.EdmValueUtils"> <summary> Class with utility methods to deal with EDM values </summary> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.ConvertPrimitiveValue(System.Object,Microsoft.OData.Edm.IEdmPrimitiveTypeReference)"> <summary> Converts a primitive OData value to the corresponding <see cref="T:Microsoft.OData.Edm.Vocabularies.IEdmDelayedValue"/>. </summary> <param name="primitiveValue">The primitive OData value to convert.</param> <param name="type">The <see cref="T:Microsoft.OData.Edm.IEdmTypeReference"/> for the primitive value (if available).</param> <returns>An <see cref="T:Microsoft.OData.Edm.Vocabularies.IEdmDelayedValue"/> for the <paramref name="primitiveValue"/>.</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.ToClrValue(Microsoft.OData.Edm.Vocabularies.IEdmPrimitiveValue)"> <summary> Gets the clr value of the edm value based on its type. </summary> <param name="edmValue">The edm value.</param> <returns>The clr value</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.TryGetStreamProperty(Microsoft.OData.Edm.Vocabularies.IEdmStructuredValue,System.String,Microsoft.OData.Edm.IEdmProperty@)"> <summary> Tries to get a stream property of the specified name. </summary> <param name="entityInstance">The instance of the entity to get the stream property for.</param> <param name="streamPropertyName">The stream property name to find.</param> <param name="streamProperty">The stream property found.</param> <returns>true if the stream property was found or if the stream property name was null (default stream). false if the stream property doesn't exist.</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.GetPrimitivePropertyClrValue(Microsoft.OData.Edm.Vocabularies.IEdmStructuredValue,System.String)"> <summary> Gets the the CLR value for a primitive property. </summary> <param name="structuredValue">The structured value.</param> <param name="propertyName">Name of the property.</param> <returns>The clr value of the property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.ConvertFloatingValue(Microsoft.OData.Edm.Vocabularies.IEdmFloatingValue,Microsoft.OData.Edm.EdmPrimitiveTypeKind)"> <summary> Converts a floating-point edm value to a clr value </summary> <param name="floatingValue">The edm floating-point value.</param> <param name="primitiveKind">Kind of the primitive.</param> <returns>The converted value</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.ConvertIntegerValue(Microsoft.OData.Edm.Vocabularies.IEdmIntegerValue,Microsoft.OData.Edm.EdmPrimitiveTypeKind)"> <summary> Converts an integer edm value to a clr value. </summary> <param name="integerValue">The integer value.</param> <param name="primitiveKind">Kind of the primitive.</param> <returns>The converted value</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.ConvertPrimitiveValueWithoutTypeCode(System.Object,Microsoft.OData.Edm.IEdmPrimitiveTypeReference)"> <summary> Convert a primitive value which didn't match any of the known values of the TypeCode enumeration. </summary> <param name="primitiveValue">The value to convert.</param> <param name="type">The expected primitive type or null.</param> <returns>The converted value.</returns> </member> <member name="M:Microsoft.OData.Evaluation.EdmValueUtils.EnsurePrimitiveType(Microsoft.OData.Edm.IEdmPrimitiveTypeReference,Microsoft.OData.Edm.EdmPrimitiveTypeKind)"> <summary> Ensures a primitive type reference for a given primitive type kind. </summary> <param name="type">The possibly null type reference.</param> <param name="primitiveKindFromValue">The primitive type kind to ensure.</param> <returns>An <see cref="T:Microsoft.OData.Edm.IEdmPrimitiveTypeReference"/> instance created for the <paramref name="primitiveKindFromValue"/> if <paramref name="type"/> is null; if <paramref name="type"/> is not null, validates it and then returns it.</returns> </member> <member name="T:Microsoft.OData.Evaluation.IODataResourceMetadataContext"> <summary> Interface used for substitutability of the metadata-centric responsibilities of a resource. Metadata may come from a user-provided model or from the SetSerializationInfo() method on a resource set or resource. The latter is considered the "no-model" case since only strings are provided, and there is no interconnectedness. The goal of this interface is to provide a way to query the metadata information available on a resource without needing to know where the metadata originated from. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.Resource"> <summary> The resource instance. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.TypeContext"> <summary> The context object to answer basic questions regarding the type of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.ActualResourceType"> <summary> The actual structured type of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.ActualResourceTypeName"> <summary> The actual structured type of the resource, i.e. ODataResource.TypeName. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.KeyProperties"> <summary> The key property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.ETagProperties"> <summary> The ETag property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.SelectedNavigationProperties"> <summary> The selected navigation properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.SelectedStreamProperties"> <summary> The selected stream properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataResourceMetadataContext.SelectedBindableOperations"> <summary> The selected bindable operations. </summary> </member> <member name="T:Microsoft.OData.Evaluation.KeySerializer"> <summary> Component for serializing entity key values for building identities, edit links, etc. </summary> </member> <member name="F:Microsoft.OData.Evaluation.KeySerializer.DefaultInstance"> <summary>Singleton instance of the default serializer.</summary> </member> <member name="F:Microsoft.OData.Evaluation.KeySerializer.SegmentInstance"> <summary>Singleton instance of the segment-based serializer.</summary> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.Create(System.Boolean)"> <summary> Creates a new key serializer. </summary> <param name="enableKeyAsSegment">Whether enable key as segment.</param> <returns>A new key serializer.</returns> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.AppendKeyExpression``1(System.Text.StringBuilder,System.Collections.Generic.ICollection{``0},System.Func{``0,System.String},System.Func{``0,System.Object})"> <summary> Appends the key expression for an entity to the given <see cref="T:System.Text.StringBuilder"/> </summary> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="builder">The builder to append onto.</param> <param name="keyProperties">The key properties.</param> <param name="getPropertyName">The callback to get each property's name.</param> <param name="getPropertyValue">The callback to get each property's value.</param> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.GetKeyValueAsString``1(System.Func{``0,System.Object},``0,Microsoft.OData.Evaluation.LiteralFormatter)"> <summary> Gets the value of the key property and serializes it to a string. </summary> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="getPropertyValue">The callback to get the value for a property.</param> <param name="property">The key property.</param> <param name="literalFormatter">The literal formatter to use.</param> <returns>The serialized key property value.</returns> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.AppendKeyWithParentheses``1(System.Text.StringBuilder,System.Collections.Generic.ICollection{``0},System.Func{``0,System.String},System.Func{``0,System.Object})"> <summary> Appends the key using the parentheses-based syntax (e.g. Customers(1)) onto the given <see cref="T:System.Text.StringBuilder"/>. </summary> <param name="builder">The builder to append onto.</param> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="keyProperties">The key properties.</param> <param name="getPropertyName">The callback to get each property's name.</param> <param name="getPropertyValue">The callback to get each property's value.</param> </member> <member name="T:Microsoft.OData.Evaluation.KeySerializer.DefaultKeySerializer"> <summary> Default implementation of the key serializer which uses parentheses (e.g. Customers(1)). </summary> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.DefaultKeySerializer.AppendKeyExpression``1(System.Text.StringBuilder,System.Collections.Generic.ICollection{``0},System.Func{``0,System.String},System.Func{``0,System.Object})"> <summary> Appends the key expression for an entity to the given <see cref="T:System.Text.StringBuilder"/> </summary> <param name="builder">The builder to append onto.</param> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="keyProperties">The key properties.</param> <param name="getPropertyName">The callback to get each property's name.</param> <param name="getPropertyValue">The callback to get each property's value.</param> </member> <member name="T:Microsoft.OData.Evaluation.KeySerializer.SegmentKeySerializer"> <summary> Implementation of the key serializer which uses segments (e.g. Customers/1). </summary> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.SegmentKeySerializer.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.OData.Evaluation.KeySerializer.SegmentKeySerializer"/>. </summary> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.SegmentKeySerializer.AppendKeyExpression``1(System.Text.StringBuilder,System.Collections.Generic.ICollection{``0},System.Func{``0,System.String},System.Func{``0,System.Object})"> <summary> Appends the key expression for an entity to the given <see cref="T:System.Text.StringBuilder"/> </summary> <param name="builder">The builder to append onto.</param> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="keyProperties">The key properties.</param> <param name="getPropertyName">The callback to get each property's name.</param> <param name="getPropertyValue">The callback to get each property's value.</param> </member> <member name="M:Microsoft.OData.Evaluation.KeySerializer.SegmentKeySerializer.AppendKeyWithSegments``1(System.Text.StringBuilder,System.Collections.Generic.ICollection{``0},System.Func{``0,System.Object})"> <summary> Appends the key for the current resource using segment-based syntax (e.g. Customers/1) onto the given <see cref="T:System.Text.StringBuilder"/>. </summary> <param name="builder">The builder to append onto.</param> <typeparam name="TProperty">The type used to represent properties.</typeparam> <param name="keyProperties">The key properties.</param> <param name="getPropertyValue">The callback to get each property's value.</param> </member> <member name="T:Microsoft.OData.Evaluation.LiteralFormatter"> <summary> Component for formatting literals for use in URIs, ETags, and skip-tokens. </summary> </member> <member name="F:Microsoft.OData.Evaluation.LiteralFormatter.DefaultInstance"> <summary>Default singleton instance for parenthetical keys, etags, or skiptokens.</summary> </member> <member name="F:Microsoft.OData.Evaluation.LiteralFormatter.DefaultInstanceWithoutEncoding"> <summary>Default singleton instance which does not URL-encode the resulting string.</summary> </member> <member name="F:Microsoft.OData.Evaluation.LiteralFormatter.KeyAsSegmentInstance"> <summary>Default singleton instance for keys formatted as segments.</summary> </member> <member name="P:Microsoft.OData.Evaluation.LiteralFormatter.ForConstants"> <summary> Gets the literal formatter for URL constants. </summary> </member> <member name="P:Microsoft.OData.Evaluation.LiteralFormatter.ForConstantsWithoutEncoding"> <summary> Gets the literal formatter for URL constants which does not URL-encode the string. </summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.ForKeys(System.Boolean)"> <summary> Gets the literal formatter for keys. </summary> <param name="keysAsSegment">if set to <c>true</c> then the key is going to be written as a segment, rather than in parentheses.</param> <returns>The literal formatter for keys.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.Format(System.Object)"> <summary>Converts the specified value to an encoded, serializable string for URI key.</summary> <param name="value">Non-null value to convert.</param> <returns>value converted to a serializable string for URI key.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.EscapeResultForUri(System.String)"> <summary> Escapes the result according to URI escaping rules. </summary> <param name="result">The result to escape.</param> <returns>The escaped string.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.ConvertByteArrayToKeyString(System.Byte[])"> <summary>Converts the given byte[] into string.</summary> <param name="byteArray">byte[] that needs to be converted.</param> <returns>String containing hex values representing the byte[].</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.FormatRawLiteral(System.Object)"> <summary> Formats the literal without a type prefix, quotes, or escaping. </summary> <param name="value">The non-null value to format.</param> <returns>The formatted literal, without type marker or quotes.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.FormatAndEscapeLiteral(System.Object)"> <summary> Formats the literal without a type prefix or quotes, but does escape it. </summary> <param name="value">The non-null value to format.</param> <returns>The formatted literal, without type marker or quotes.</returns> </member> <member name="T:Microsoft.OData.Evaluation.LiteralFormatter.SharedUtils"> <summary> Helper utilities that capture any deltas between ODL, the WCF DS Client, and the WCF DS Server. </summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.SharedUtils.CreateExceptionForUnconvertableType(System.Object)"> <summary> Creates a new exception instance to be thrown if the value is not a type that can be formatted as a literal. DEVNOTE: Will return a different exception depending on whether this is ODataLib, the WCF DS Server, or the WCF DS client. </summary> <param name="value">The literal value that could not be converted.</param> <returns>The exception that should be thrown.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.SharedUtils.TryConvertToStandardType(System.Object,System.Object@)"> <summary> Tries to convert the given value to one of the standard recognized types. Used specifically for handling XML and binary types. </summary> <param name="value">The original value.</param> <param name="converted">The value converted to one of the standard types.</param> <returns>Whether or not the value was converted.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.SharedUtils.AppendDecimalMarkerToDouble(System.String)"> <summary> Appends the decimal marker to string form of double value if necessary. DEVNOTE: Only used by the client and ODL, for legacy/back-compat reasons. </summary> <param name="input">Input string.</param> <returns>String with decimal marker optionally added.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.SharedUtils.TryGetByteArrayFromBinary(System.Object,System.Byte[]@)"> <summary> Tries to convert an instance of System.Data.Linq.Binary to a byte array. </summary> <param name="value">The original value which might be an instance of System.Data.Linq.Binary.</param> <param name="array">The converted byte array, if it was converted.</param> <returns>Whether or not the value was converted.</returns> </member> <member name="T:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter"> <summary> Default literal formatter implementation. </summary> </member> <member name="F:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.disableUrlEncoding"> <summary>If true, literals will not be URL encoded.</summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter"/>. </summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.#ctor(System.Boolean)"> <summary> Creates a new instance of <see cref="T:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter"/>. </summary> <param name="disableUrlEncoding">If true, literals will not be URL encoded.</param> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.Format(System.Object)"> <summary>Converts the specified value to an encoded, serializable string for URI key.</summary> <param name="value">Non-null value to convert.</param> <returns>value converted to a serializable string for URI key.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.EscapeResultForUri(System.String)"> <summary> Escapes the result according to URI escaping rules. </summary> <param name="result">The result to escape.</param> <returns>The escaped string.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.DefaultLiteralFormatter.FormatLiteralWithTypePrefix(System.Object)"> <summary> Formats the literal with a type prefix and quotes (if the type requires it). </summary> <param name="value">The value to format.</param> <returns>The formatted literal, with type marker if needed.</returns> </member> <member name="T:Microsoft.OData.Evaluation.LiteralFormatter.KeysAsSegmentsLiteralFormatter"> <summary> Literal formatter for keys which are written as URI segments. Very similar to the default, but it never puts the type markers or single quotes around the value. </summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.KeysAsSegmentsLiteralFormatter.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.OData.Evaluation.LiteralFormatter.KeysAsSegmentsLiteralFormatter"/>. </summary> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.KeysAsSegmentsLiteralFormatter.Format(System.Object)"> <summary>Converts the specified value to an encoded, serializable string for URI key.</summary> <param name="value">Non-null value to convert.</param> <returns>value converted to a serializable string for URI key.</returns> </member> <member name="M:Microsoft.OData.Evaluation.LiteralFormatter.KeysAsSegmentsLiteralFormatter.EscapeLeadingDollarSign(System.String)"> <summary> If the string starts with a '$', prepends another '$' to escape it. </summary> <param name="stringValue">The string value.</param> <returns>The string value with a leading '$' escaped, if one was present.</returns> </member> <member name="T:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder"> <summary> Implementation of the metadata builder which only returns values which were explicitly set (never computing or modifying them). </summary> </member> <member name="F:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.resource"> <summary> The resource whose payload metadata is being queried. </summary> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.#ctor(Microsoft.OData.ODataResourceBase)"> <summary> Creates a new no-op metadata builder. </summary> <param name="resource">The resource whose payload metadata is being queried.</param> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetEditLink"> <summary> Gets the edit link of the entity. </summary> <returns> The absolute URI of the edit link for the entity. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetReadLink"> <summary> Gets the read link of the entity. </summary> <returns> The absolute URI of the read link for the entity. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetId"> <summary> Gets the ID of the entity. </summary> <returns> The ID for the entity. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetETag"> <summary> Gets the ETag of the entity. </summary> <returns> The ETag for the entity. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetMediaResource"> <summary> Gets the default media resource of the entity. </summary> <returns> The the default media resource of the entity. Or null if the entity is not an MLE. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetProperties(System.Collections.Generic.IEnumerable{Microsoft.OData.ODataProperty})"> <summary> Gets the entity properties. </summary> <param name="nonComputedProperties">Non-computed properties from the entity.</param> <returns>The the computed and non-computed entity properties.</returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetActions"> <summary> Gets the list of computed and non-computed actions for the entity. </summary> <returns>The list of computed and non-computed actions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetFunctions"> <summary> Gets the list of computed and non-computed functions for the entity. </summary> <returns>The list of computed and non-computed functions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetNavigationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the navigation link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <param name="navigationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasNestedResourceInfoUrl">true if the value of the <paramref name="navigationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null navigation link url is an uninitialized value or a value that was set explicitly.</param> <returns> The navigation link URI for the navigation property. null if its not possible to determine the navigation link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.GetAssociationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the association link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <param name="associationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasAssociationLinkUrl">true if the value of the <paramref name="associationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null association link url is an uninitialized value or a value that was set explicitly.</param> <returns> The association link URI for the navigation property. null if its not possible to determine the association link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.NoOpResourceMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Get the id that need to be written into wire </summary> <param name="id">The id return to the caller</param> <returns> If writer should write odata.id property into wire </returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder"> <summary> Implementation of OData entity metadata builder based on OData protocol conventions. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.computedEditLink"> <summary>The edit link.</summary> <remarks>This is lazily evaluated. It may be retrieved from the resource or computed.</remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.computedReadLink"> <summary>The read link.</summary> <remarks>This is lazily evaluated. It may be retrieved from the resource or computed.</remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.computedETag"> <summary>The computed ETag.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.etagComputed"> <summary>true if the etag value has been computed, false otherwise.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.computedMediaResource"> <summary>The computed MediaResource for MLEs.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.computedStreamProperties"> <summary>The list of computed stream properties.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.isResourceEnd"> <summary> Mark if we are at state of ResourceEnd, if it is true, GetProperties would concat computed stream properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.missingOperationGenerator"> <summary>The missing operation generator for the current resource.</summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.#ctor(Microsoft.OData.Evaluation.IODataResourceMetadataContext,Microsoft.OData.Evaluation.IODataMetadataContext,Microsoft.OData.Evaluation.ODataUriBuilder)"> <summary> Constructor </summary> <param name="resourceMetadataContext">The context to answer basic metadata questions about the resource.</param> <param name="metadataContext">The metadata context.</param> <param name="uriBuilder">The uri builder to use.</param> </member> <member name="P:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.MissingOperationGenerator"> <summary> The missing operation generator for the current resource. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetCanonicalUrl"> <summary> Gets canonical url of current resource. </summary> <returns>The canonical url of current resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetEditUrl"> <summary> Gets the edit url of current entity. </summary> <returns>The edit url of current entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetReadUrl"> <summary> Gets the read url of current entity. </summary> <returns>The read url of current entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetEditLink"> <summary> Gets the edit link of the entity. </summary> <returns> The absolute URI of the edit link for the entity. Or null if it is not possible to determine the edit link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetReadLink"> <summary> Gets the read link of the entity. </summary> <returns> The absolute URI of the read link for the entity. Or null if it is not possible to determine the read link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetETag"> <summary> Gets the ETag of the entity. </summary> <returns> The ETag for the entity. Or null if it is not possible to determine the ETag. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetMediaResource"> <summary> Gets the default media resource of the entity. </summary> <returns> The the default media resource of the entity. Or null if the entity is not an MLE. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetProperties(System.Collections.Generic.IEnumerable{Microsoft.OData.ODataProperty})"> <summary> Gets the entity properties. </summary> <param name="nonComputedProperties">Non-computed properties from the entity.</param> <returns>The the computed and non-computed entity properties.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.StartResource"> <summary> Mark the resource is just started to process. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.EndResource"> <summary> Mark the resource has finished the processing. So GetProperties() need append ComputedStreamProperties for entity. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetActions"> <summary> Gets the list of computed and non-computed actions for the entity. </summary> <returns>The list of computed and non-computed actions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetFunctions"> <summary> Gets the list of computed and non-computed functions for the entity. </summary> <returns>The list of computed and non-computed functions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetNavigationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the navigation link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <param name="navigationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasNestedResourceInfoUrl">true if the value of the <paramref name="navigationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null navigation link url is an uninitialized value or a value that was set explicitly.</param> <returns> The navigation link URI for the navigation property. null if its not possible to determine the navigation link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetAssociationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the association link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <param name="associationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasAssociationLinkUrl">true if the value of the <paramref name="associationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null association link url is an uninitialized value or a value that was set explicitly.</param> <returns> The association link URI for the navigation property. null if its not possible to determine the association link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetOperationTargetUri(System.String,System.String,System.String)"> <summary> Get the operation target URI for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <param name="bindingParameterTypeName">The binding parameter type name.</param> <param name="parameterNames">The parameter names to include in the target, or null/empty if there is none.</param> <returns> The target URI for the operation. null if it is not possible to determine the target URI for the specified operation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetOperationTitle(System.String)"> <summary> Get the operation title for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <returns> The title for the operation. null if it is not possible to determine the title for the specified operation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Get the id that need to be written into wire </summary> <param name="id">The id return to the caller</param> <returns> If writer should write odata.id property into wire </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.ComputeEditLink"> <summary> Computes the edit link. </summary> <returns>Uri that was computed based on the computed Id and possible type segment.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalEntityMetadataBuilder.GetComputedStreamProperties(System.Collections.Generic.IEnumerable{Microsoft.OData.ODataProperty})"> <summary> Computes all projected or missing stream properties. </summary> <param name="nonComputedProperties">Non-computed properties from the entity.</param> <returns>The the computed stream properties for the resource.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder"> <summary> Implementation of OData metadata builder that generates ids based on OData protocol conventions. This specifically does NOT generate navigation links/stream properties as it is used for deltas. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.computedId"> <summary>The computed ID of this entity instance.</summary> <remarks> This is always built from the key properties, and never comes from the resource. </remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.computedKeyProperties"> <summary>The computed key property name and value pairs of the resource.</summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.#ctor(Microsoft.OData.Evaluation.IODataResourceMetadataContext,Microsoft.OData.Evaluation.IODataMetadataContext,Microsoft.OData.Evaluation.ODataUriBuilder)"> <summary> Constructor </summary> <param name="resourceMetadataContext">The context to answer basic metadata questions about the resource.</param> <param name="metadataContext">The metadata context.</param> <param name="uriBuilder">The uri builder to use.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.GetCanonicalUrl"> <summary> Gets canonical url of current resource. </summary> <returns>The canonical url of current resource.</returns> </member> <member name="P:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputedId"> <summary> Lazy evaluated computed entity Id. This is always a computed value and never comes from the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputedKeyProperties"> <summary> The computed key property name and value pairs of the resource. If a value is unsigned integer, it will be automatically converted to its underlying type. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.GetId"> <summary> Gets the ID of the entity. </summary> <returns> The ID for the entity. Or null if it is not possible to determine the ID. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Get the id that need to be written into wire </summary> <param name="id">The id return to the caller</param> <returns> If writer should write odata.id property into wire </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputeAndCacheId"> <summary> Computes and sets the field for the computed Id. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputeId"> <summary> Compute id for neither singleton, nor containment scenario. </summary> <returns> The <see cref="T:System.Uri"/> of @odata.id. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputeIdForContainment"> <summary> Compute id for containment scenario. </summary> <returns> The <see cref="T:System.Uri"/> of @odata.id. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.ComputeIdForSingleton"> <summary> Compute id for singleton scenario. </summary> <returns> The <see cref="T:System.Uri"/> of @odata.id. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalIdMetadataBuilder.GetContainingEntitySetUri(System.Uri,Microsoft.OData.UriParser.ODataPath)"> <summary> Gets resource path from service root, and request Uri. </summary> <param name="baseUri">The service root Uri.</param> <param name="odataUri">The request Uri.</param> <returns>The resource path.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder"> <summary> Implementation of OData resource metadata builder based on OData protocol conventions. This metadata builder will be created for complex or for the resource which is not explicitly known as entity. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.ResourceMetadataContext"> <summary>The context to answer basic metadata questions about the resource.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.UriBuilder"> <summary>The URI builder to use.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.MetadataContext"> <summary>The metadata context.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.ProcessedNestedResourceInfos"> <summary>The list of nested info that have been processed. Here navigation property and complex will both be marked for convenience.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.ProcessedStreamProperties"> <summary>The list of stream properties that have been processed.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.unprocessedNavigationLinks"> <summary>The enumerator for unprocessed navigation links.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.unprocessedStreamProperties"> <summary>The enumerator for unprocessed streamProperties.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.readUrl"> <summary>The read url.</summary> <remarks>This is lazily evaluated. It may be retrieved from the resource or computed.</remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.editUrl"> <summary>The edit url.</summary> <remarks>This is lazily evaluated. It may be retrieved from the resource or computed.</remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.canonicalUrl"> <summary>The canonical url. </summary> <remarks>This is lazily evaluated. It may be retrieved from the resource or computed.</remarks> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.resource"> <summary> The resource whose payload metadata is being queried. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.#ctor(Microsoft.OData.Evaluation.IODataResourceMetadataContext,Microsoft.OData.Evaluation.IODataMetadataContext,Microsoft.OData.Evaluation.ODataUriBuilder)"> <summary> Constructor </summary> <param name="resourceMetadataContext">The context to answer basic metadata questions about the resource.</param> <param name="metadataContext">The metadata context.</param> <param name="uriBuilder">The uri builder to use.</param> </member> <member name="P:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.ODataUri"> <summary> OData uri that parsed based on the context url </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetEditUrl"> <summary> Gets edit url of current resource. Computes edit url of current resource from: 1. NonComputedEditLink 2. CanonicalUrl 3. Parent edit url </summary> <returns>The edit url of current resource.</returns> <remarks>The method is used to compute edit Url for current resource, including complex.</remarks> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetReadUrl"> <summary> Gets read url of current resource. Computes read url of current resource from: 1. NonComputedReadLink 2. Computed edit url 3. Parent read url </summary> <returns>The read url of current resource.</returns> <remarks>The method is used to compute edit url for resource, including complex.</remarks> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetCanonicalUrl"> <summary> Gets canonical url of current resource. </summary> <returns>The canonical url of current resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.StartResource"> <summary> Mark the resource is just started to process. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.EndResource"> <summary> Mark the resource has finished the processing. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetEditLink"> <summary> Gets the edit link of the resource. </summary> <returns>The edit link of the resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetReadLink"> <summary> Gets the read link of the resource. </summary> <returns>The read link of the resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetId"> <summary> Gets the id of the resource. Only applies entity, so return null here, and will be overridden by entity. </summary> <returns>null</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Tries to get id which is needed to written into wire. Only applies to entity. </summary> <param name="id">The id returns to caller, null here and will be overridden by entity.</param> <returns>false</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetETag"> <summary> Gets the etag for current resource. </summary> <returns>The etag for current resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetProperties(System.Collections.Generic.IEnumerable{Microsoft.OData.ODataProperty})"> <summary> Gets the entity properties. </summary> <param name="nonComputedProperties">Non-computed properties from the entity.</param> <returns>The the computed and non-computed entity properties.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetActions"> <summary> Gets the list of computed and non-computed actions for the entity. </summary> <returns>The list of computed and non-computed actions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetFunctions"> <summary> Gets the list of computed and non-computed functions for the entity. </summary> <returns>The list of computed and non-computed functions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.MarkNestedResourceInfoProcessed(System.String)"> <summary> Marks the given nested resource info as processed. </summary> <param name="navigationPropertyName">The nested resource info we've already processed.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetNextUnprocessedNavigationLink"> <summary> Returns the next unprocessed navigation link or null if there's no more navigation links to process. </summary> <returns>Returns the next unprocessed navigation link or null if there's no more navigation links to process.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.MarkStreamPropertyProcessed(System.String)"> <summary> Marks the given stream property as processed. </summary> <param name="streamPropertyName">The stream property we've already processed.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetNextUnprocessedStreamProperty"> <summary> Returns the next unprocessed stream property or null if there's no more stream properties to process. </summary> <returns>Returns the next unprocessed stream property or null if there's no more stream properties to process.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetNavigationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the navigation link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <param name="navigationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasNestedResourceInfoUrl">true if the value of the <paramref name="navigationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null navigation link url is an uninitialized value or a value that was set explicitly.</param> <returns> The navigation link URI for the navigation property. null if its not possible to determine the navigation link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetAssociationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the association link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <param name="associationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasAssociationLinkUrl">true if the value of the <paramref name="associationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null association link url is an uninitialized value or a value that was set explicitly.</param> <returns> The association link URI for the navigation property. null if its not possible to determine the association link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetStreamEditLink(System.String)"> <summary> Gets the edit link of a stream value. </summary> <param name="streamPropertyName">The name of the stream property the edit link is computed for; or null for the default media resource.</param> <returns> The absolute URI of the edit link for the specified stream property or the default media resource. Or null if it is not possible to determine the stream edit link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetStreamReadLink(System.String)"> <summary> Gets the read link of a stream value. </summary> <param name="streamPropertyName">The name of the stream property the read link is computed for; or null for the default media resource.</param> <returns> The absolute URI of the read link for the specified stream property or the default media resource. Or null if it is not possible to determine the stream read link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetOperationTargetUri(System.String,System.String,System.String)"> <summary> Get the operation target URI for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <param name="bindingParameterTypeName">The binding parameter type name.</param> <param name="parameterNames">The parameter names to include in the target, or null/empty if there is none.</param> <returns> The target URI for the operation. null if it is not possible to determine the target URI for the specified operation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalResourceMetadataBuilder.GetOperationTitle(System.String)"> <summary> Get the operation title for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <returns> The title for the operation. null if it is not possible to determine the title for the specified operation. </returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataConventionalUriBuilder"> <summary> Implementation of OData URI builder based on OData protocol conventions. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.serviceBaseUri"> <summary>The base URI of the service. This will be used as the base URI for all entity containers.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.keySerializer"> <summary>The specific key-serializer to use based on the convention.</summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.#ctor(System.Uri,Microsoft.OData.ODataUrlKeyDelimiter)"> <summary> Constructor. </summary> <param name="serviceBaseUri">The base URI of the service. This will be used as the base URI for all entity containers.</param> <param name="urlKeyDelimiter">Key delimiter used in url.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildBaseUri"> <summary> Builds the base URI for the entity container. </summary> <returns> The base URI for the entity container. This can be either an absolute URI, or relative URI which will be combined with the URI of the metadata document for the service. null if the model doesn't have the service base URI annotation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildEntitySetUri(System.Uri,System.String)"> <summary> Builds the URI for an entity set. </summary> <param name="baseUri">The URI to append to.</param> <param name="entitySetName">The entity set name.</param> <returns>The entity set URI.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildEntityInstanceUri(System.Uri,System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.String)"> <summary> Builds the entity instance URI with the given key property values. </summary> <param name="baseUri">The URI to append to.</param> <param name="keyProperties">The list of name value pair for key properties.</param> <param name="entityTypeName">The full name of the entity type we are building the key expression for.</param> <returns>The entity instance URI.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildStreamEditLinkUri(System.Uri,System.String)"> <summary> Builds the edit link for a stream property. </summary> <param name="baseUri">The URI to append to.</param> <param name="streamPropertyName"> The name of the stream property the link is computed for; or null for the default media resource. </param> <returns>The edit link for the stream.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildStreamReadLinkUri(System.Uri,System.String)"> <summary> Builds the read link for a stream property. </summary> <param name="baseUri">The URI to append to.</param> <param name="streamPropertyName"> The name of the stream property the link is computed for; or null for the default media resource. </param> <returns>The read link for the stream.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildNavigationLinkUri(System.Uri,System.String)"> <summary> Builds the navigation link for the navigation property. </summary> <param name="baseUri">The URI to append to.</param> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <returns>The navigation link URI for the navigation property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildAssociationLinkUri(System.Uri,System.String)"> <summary> Builds the association link for the navigation property. </summary> <param name="baseUri">The URI to append to.</param> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <returns>The association link URI for the navigation property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.BuildOperationTargetUri(System.Uri,System.String,System.String,System.String)"> <summary> Builds the operation target URI for the specified <paramref name="operationName"/>. </summary> <param name="baseUri">The URI to append to.</param> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <param name="bindingParameterTypeName">The binding parameter type name to include in the target, or null/empty if there is none.</param> <param name="parameterNames">The parameter names to include in the target, or null/empty if there is none.</param> <returns>The target URI for the operation.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.AppendTypeSegment(System.Uri,System.String)"> <summary> Builds a URI with the given type name appended as a new segment on the base URI. </summary> <param name="baseUri">The URI to append to.</param> <param name="typeName">The fully qualified type name to append.</param> <returns>The URI with the type segment appended.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.ValidateBaseUri(System.Uri)"> <summary> Validates the base URI parameter to be a non-null absolute URI. </summary> <param name="baseUri">The base URI parameter to validate.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.AppendSegment(System.Uri,System.String,System.Boolean)"> <summary> Appends a segment to the specified base URI. </summary> <param name="baseUri">The base Uri to append the segment to.</param> <param name="segment">The segment to append.</param> <param name="escapeSegment">True if the new segment should be escaped, otherwise False.</param> <returns>New URI with the appended segment and no trailing slash added.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.ValidateKeyValue(System.String,System.Object,System.String)"> <summary> Gets the CLR value of a primitive key property. </summary> <param name="keyPropertyName">The key property name.</param> <param name="keyPropertyValue">The key property value.</param> <param name="entityTypeName">The entity type name we are validating the key value for.</param> <returns>The primitive value of the key property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataConventionalUriBuilder.AppendKeyExpression(System.Text.StringBuilder,System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.String)"> <summary> Appends the key expression for the given entity to the given <see cref="T:System.Text.StringBuilder"/> </summary> <param name="builder">The builder to append onto.</param> <param name="keyProperties">The list of name value pair for key properties.</param> <param name="entityTypeName">The full name of the entity type we are building the key expression for.</param> </member> <member name="T:Microsoft.OData.Evaluation.IODataMetadataContext"> <summary> Interface used for substitutability of the metadata-centric responsibilities of <see cref="T:Microsoft.OData.JsonLight.ODataJsonLightDeserializer"/>. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataMetadataContext.Model"> <summary> Gets the Edm Model. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataMetadataContext.ServiceBaseUri"> <summary> Gets the service base Uri. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataMetadataContext.MetadataDocumentUri"> <summary> Gets the metadata document uri. </summary> </member> <member name="P:Microsoft.OData.Evaluation.IODataMetadataContext.ODataUri"> <summary> Gets the OData uri. </summary> </member> <member name="M:Microsoft.OData.Evaluation.IODataMetadataContext.GetResourceMetadataBuilderForReader(Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState,System.Boolean,System.Boolean)"> <summary> Gets an entity metadata builder for the given resource. </summary> <param name="resourceState">Resource state to use as reference for information needed by the builder.</param> <param name="useKeyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses.</param> <param name="isDelta">true if the payload being read is a delta payload.</param> <returns>An entity metadata builder.</returns> </member> <member name="M:Microsoft.OData.Evaluation.IODataMetadataContext.GetBindableOperationsForType(Microsoft.OData.Edm.IEdmType)"> <summary> Gets the list of operations that are bindable to a type. </summary> <param name="bindingType">The binding type in question.</param> <returns>The list of operations that are always bindable to a type.</returns> </member> <member name="M:Microsoft.OData.Evaluation.IODataMetadataContext.OperationsBoundToStructuredTypeMustBeContainerQualified(Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Determines whether operations bound to this type must be qualified with the operation they belong to when appearing in a $select clause. </summary> <param name="structuredType">The structured type the operations are bound to.</param> <returns>True if the operations must be container qualified, otherwise false.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataMetadataContext"> <summary> Default implementation of <see cref="T:Microsoft.OData.Evaluation.IODataMetadataContext"/>. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.model"> <summary> The Edm Model. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.edmTypeResolver"> <summary> EdmTypeResolver instance to resolve entity set base type. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.isResponse"> <summary> true if we are reading or writing a response payload, false otherwise. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.operationsBoundToStructuredTypeMustBeContainerQualified"> <summary> Callback to determine whether operations bound to this type must be qualified with the operation they belong to when appearing in a $select clause. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.metadataDocumentUri"> <summary> The metadata document Uri. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.odataUri"> <summary> The OData Uri. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.serviceBaseUri"> <summary> The service base Uri. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMetadataContext.metadataLevel"> <summary> The MetadataLevel. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.#ctor(System.Boolean,Microsoft.OData.Edm.IEdmModel,System.Uri,System.Nullable{Microsoft.OData.ODataUriSlim}@)"> <summary> Constructs an ODataMetadataContext. </summary> <param name="isResponse">true if we are writing a response payload, false otherwise.</param> <param name="model">The Edm model.</param> <param name="metadataDocumentUri">The metadata document uri.</param> <param name="odataUri">The request Uri.</param> <remarks>This overload should only be used by the writer.</remarks> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.#ctor(System.Boolean,System.Func{Microsoft.OData.Edm.IEdmStructuredType,System.Boolean},Microsoft.OData.Metadata.EdmTypeResolver,Microsoft.OData.Edm.IEdmModel,System.Uri,System.Nullable{Microsoft.OData.ODataUriSlim}@)"> <summary> Constructs an ODataMetadataContext. </summary> <param name="isResponse">true if we are reading a response payload, false otherwise.</param> <param name="operationsBoundToStructuredTypeMustBeContainerQualified">Callback to determine whether operations bound to this type must be qualified with the operation they belong to when appearing in a $select clause.</param> <param name="edmTypeResolver">EdmTypeResolver instance to resolve entity set base type.</param> <param name="model">The Edm model.</param> <param name="metadataDocumentUri">The metadata document Uri.</param> <param name="odataUri">The request Uri.</param> <remarks>This overload should only be used by the reader.</remarks> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.#ctor(System.Boolean,System.Func{Microsoft.OData.Edm.IEdmStructuredType,System.Boolean},Microsoft.OData.Metadata.EdmTypeResolver,Microsoft.OData.Edm.IEdmModel,System.Uri,System.Nullable{Microsoft.OData.ODataUriSlim}@,Microsoft.OData.JsonLight.JsonLightMetadataLevel)"> <summary> Constructs an ODataMetadataContext. </summary> <param name="isResponse">true if we are reading a response payload, false otherwise.</param> <param name="operationsBoundToEntityTypeMustBeContainerQualified">Callback to determine whether operations bound to this type must be qualified with the operation they belong to when appearing in a $select clause.</param> <param name="edmTypeResolver">EdmTypeResolver instance to resolve entity set base type.</param> <param name="model">The Edm model.</param> <param name="metadataDocumentUri">The metadata document Uri.</param> <param name="odataUri">The request Uri.</param> <param name="metadataLevel">Current Json Light MetadataLevel</param> <remarks>This overload should only be used by the reader.</remarks> </member> <member name="P:Microsoft.OData.Evaluation.ODataMetadataContext.Model"> <summary> Gets the Edm Model. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataMetadataContext.ServiceBaseUri"> <summary> Gets the service base Uri. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataMetadataContext.MetadataDocumentUri"> <summary> Gets the metadata document uri. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataMetadataContext.ODataUri"> <summary> Gets the OData uri. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.GetResourceMetadataBuilderForReader(Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState,System.Boolean,System.Boolean)"> <summary> Gets a resource metadata builder for the given resource. </summary> <param name="resourceState">Resource state to use as reference for information needed by the builder.</param> <param name="useKeyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses.</param> <param name="isDelta">true if the payload being read is a delta payload</param> <returns>A resource metadata builder.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.GetBindableOperationsForType(Microsoft.OData.Edm.IEdmType)"> <summary> Gets the list of operations that are always bindable to a type. </summary> <param name="bindingType">The binding type in question.</param> <returns>The list of operations that are always bindable to a type.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataContext.OperationsBoundToStructuredTypeMustBeContainerQualified(Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Determines whether operations bound to this type must be qualified with the operation they belong to when appearing in a $select clause. </summary> <param name="structuredType">The structured type the operations are bound to.</param> <returns>True if the operations must be container qualified, otherwise false.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataMetadataSelector"> <summary> The role of this class is to control what metadata information gets written for full metadata. Navigation links, association links, operations and stream properties can be modified for a full metadata response. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataSelector.SelectNavigationProperties(Microsoft.OData.Edm.IEdmStructuredType,System.Collections.Generic.IEnumerable{Microsoft.OData.Edm.IEdmNavigationProperty})"> <summary> Alters the selected navigation properties for which the metadata needs to be written. </summary> <param name="type">Edm type of the resource on which the navigation property exists.</param> <param name="navigationProperties">Enumerable of selected navigation properties.</param> <returns>The list of navigation properties to be written.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataSelector.SelectBindableOperations(Microsoft.OData.Edm.IEdmStructuredType,System.Collections.Generic.IEnumerable{Microsoft.OData.Edm.IEdmOperation})"> <summary> Alters the bindable operations for the type which may get written with full metadata response. </summary> <param name="type">Edm type of the resource on which the navigation property exists.</param> <param name="bindableOperations">Enumerable of the operations whose metadata gets written out by convention.</param> <returns>The list of bound operations to be written.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMetadataSelector.SelectStreamProperties(Microsoft.OData.Edm.IEdmStructuredType,System.Collections.Generic.IEnumerable{Microsoft.OData.Edm.IEdmStructuralProperty})"> <summary> Alters the selected stream properties for the type which may get written with full metadata response. </summary> <param name="type">Edm type of the resource on which the navigation property exists.</param> <param name="selectedStreamProperties">enumerable of the selected stream properties.</param> <returns>The list of stream properties to be written.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataMissingOperationGenerator"> <summary> Generates operations which were omitted by the service because they fully match conventions/templates and are always available. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.metadataContext"> <summary>The current resource metadata context.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.resourceMetadataContext"> <summary>The metadata context of the resource to generate the missing operations for.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.computedActions"> <summary>The list of computed actions.</summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.computedFunctions"> <summary>The list of computed functions.</summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.#ctor(Microsoft.OData.Evaluation.IODataResourceMetadataContext,Microsoft.OData.Evaluation.IODataMetadataContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.OData.Evaluation.ODataMissingOperationGenerator"/> class. </summary> <param name="resourceMetadataContext">The metadata context of the resource to generate the missing operations for.</param> <param name="metadataContext">The current resource metadata context.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.GetComputedActions"> <summary> Gets the computed missing Actions from the generator. </summary> <returns>The computed missing Actions.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.GetComputedFunctions"> <summary> Gets the computed missing Functions from the generator. </summary> <returns>The computed missing Functions.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.GetOperationsInEntry(Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmModel,System.Uri)"> <summary> Returns a hash set of operation imports (actions and functions) in the given resource. </summary> <param name="resource">The resource in question.</param> <param name="model">The edm model to resolve operation imports.</param> <param name="metadataDocumentUri">The metadata document uri.</param> <returns>The hash set of operation imports (actions and functions) in the given resource.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataMissingOperationGenerator.ComputeMissingOperationsToResource"> <summary> Computes the operations that are missing from the payload but should be added by conventions onto the resource. </summary> </member> <member name="T:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder"> <summary> Extensibility point for customizing how OData entity metadata (edit-links, IDs, ETags, etc) is built. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.Null"> <summary> Gets an instance of the metadata builder which never returns anything other than nulls. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.ParentMetadataBuilder"> <summary> Gets instance of the metadata builder which belongs to the parent odata resource </summary> <returns> The metadata builder of the parent odata resource Or null if there is no parent odata resource </returns> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.IsFromCollection"> <summary> Whether the resource is from collection. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NameAsProperty"> <summary> The name of property that current resource represents. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetEditLink"> <summary> Gets the edit link of the entity. </summary> <returns> The absolute URI of the edit link for the entity. Or null if it is not possible to determine the edit link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetReadLink"> <summary> Gets the read link of the entity. </summary> <returns> The absolute URI of the read link for the entity. Or null if it is not possible to determine the read link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetId"> <summary> Gets the ID of the entity. </summary> <returns> The ID for the entity. Or null if it is not possible to determine the ID. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Get the id that need to be written into wire </summary> <param name="id">The id return to the caller</param> <returns> If writer should write odata.id property into wire </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetETag"> <summary> Gets the ETag of the entity. </summary> <returns> The ETag for the entity. Or null if it is not possible to determine the ETag. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetMediaResource"> <summary> Gets the default media resource of the entity. </summary> <returns> The the default media resource of the entity. Or null if the entity is not an MLE. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetProperties(System.Collections.Generic.IEnumerable{Microsoft.OData.ODataProperty})"> <summary> Gets the entity properties. </summary> <param name="nonComputedProperties">Non-computed properties from the entity.</param> <returns>The the computed and non-computed entity properties.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetActions"> <summary> Gets the list of computed and non-computed actions for the entity. </summary> <returns>The list of computed and non-computed actions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetFunctions"> <summary> Gets the list of computed and non-computed functions for the entity. </summary> <returns>The list of computed and non-computed functions for the entity.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.MarkNestedResourceInfoProcessed(System.String)"> <summary> Marks the given nested resource info as processed. </summary> <param name="navigationPropertyName">The nested resource info we've already processed.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetNextUnprocessedStreamProperty"> <summary> Returns the next unprocessed stream property or null if there's no more stream properties to process. </summary> <returns>Returns the next unprocessed stream property or null if there's no more stream properties to process.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.MarkStreamPropertyProcessed(System.String)"> <summary> Marks the given stream property as processed. </summary> <param name="streamPropertyName">The stream property we've already processed.</param> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetNextUnprocessedNavigationLink"> <summary> Returns the next unprocessed nested resource info or null if there's no more navigation links to process. </summary> <returns>Returns the next unprocessed nested resource info or null if there's no more navigation links to process.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetStreamEditLink(System.String)"> <summary> Gets the edit link of a stream value. </summary> <param name="streamPropertyName">The name of the stream property the edit link is computed for; or null for the default media resource.</param> <returns> The absolute URI of the edit link for the specified stream property or the default media resource. Or null if it is not possible to determine the stream edit link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetStreamReadLink(System.String)"> <summary> Gets the read link of a stream value. </summary> <param name="streamPropertyName">The name of the stream property the read link is computed for; or null for the default media resource.</param> <returns> The absolute URI of the read link for the specified stream property or the default media resource. Or null if it is not possible to determine the stream read link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetNavigationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the navigation link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <param name="navigationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasNestedResourceInfoUrl">true if the value of the <paramref name="navigationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null navigation link url is an uninitialized value or a value that was set explicitly.</param> <returns> The navigation link URI for the navigation property. null if its not possible to determine the navigation link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetAssociationLinkUri(System.String,System.Uri,System.Boolean)"> <summary> Gets the association link URI for the specified navigation property. </summary> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <param name="associationLinkUrl">The value of the link URI as seen on the wire or provided explicitly by the user or previously returned by the metadata builder, which may be null.</param> <param name="hasAssociationLinkUrl">true if the value of the <paramref name="associationLinkUrl"/> was seen on the wire or provided explicitly by the user or previously returned by the metadata builder, false otherwise. This flag allows the metadata builder to determine whether a null association link url is an uninitialized value or a value that was set explicitly.</param> <returns> The association link URI for the navigation property. null if its not possible to determine the association link for the specified navigation property. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetOperationTargetUri(System.String,System.String,System.String)"> <summary> Get the operation target URI for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <param name="bindingParameterTypeName">The binding parameter type name to include in the target, or null/empty if there is none.</param> <param name="parameterNames">The parameter names to include in the target, or null/empty if there is none.</param> <returns> The target URI for the operation. null if it is not possible to determine the target URI for the specified operation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.GetOperationTitle(System.String)"> <summary> Get the operation title for the specified <paramref name="operationName"/>. </summary> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <returns> The title for the operation. null if it is not possible to determine the title for the specified operation. </returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder"> <summary> Implementation of the metadata builder which only returns nulls. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.Instance"> <summary> Singleton instance of the null metadata builder. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.#ctor"> <summary> Prevents a default instance of the <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder"/> class from being created. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.GetEditLink"> <summary> Gets the edit link of the entity. </summary> <returns> The absolute URI of the edit link for the entity. Or null if it is not possible to determine the edit link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.GetReadLink"> <summary> Gets the read link of the entity. </summary> <returns> The absolute URI of the read link for the entity. Or null if it is not possible to determine the read link. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.GetId"> <summary> Gets the ID of the entity. </summary> <returns> The ID for the entity. Or null if it is not possible to determine the ID. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.GetETag"> <summary> Gets the ETag of the entity. </summary> <returns> The ETag for the entity. Or null if it is not possible to determine the ETag. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataBuilder.NullResourceMetadataBuilder.TryGetIdForSerialization(System.Uri@)"> <summary> Get the id that need to be written into wire </summary> <param name="id">The id return to the caller</param> <returns> If writer should write odata.id property into wire </returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext"> <summary> Default implementation of <see cref="T:Microsoft.OData.Evaluation.IODataResourceMetadataContext"/> </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.EmptyProperties"> <summary> Empty array of properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.resource"> <summary> The resource instance. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.typeContext"> <summary> The context object to answer basic questions regarding the type of the resource. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.keyProperties"> <summary> The key property name and value pairs of the resource. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.etagProperties"> <summary> The ETag property name and value pairs of the resource. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.selectedNavigationProperties"> <summary> The selected navigation properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.selectedStreamProperties"> <summary> The selected stream properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.selectedBindableOperations"> <summary> The selected bindable operations. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.#ctor(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext)"> <summary> Constructs an instance of <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext"/>. </summary> <param name="resource">The resource instance.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource.</param> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.Resource"> <summary> The resource instance. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.TypeContext"> <summary> The context object to answer basic questions regarding the type of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ActualResourceType"> <summary> The actual structured type of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ActualResourceTypeName"> <summary> The actual structured type of the resource, i.e. ODataResource.TypeName. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.KeyProperties"> <summary> The key property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ETagProperties"> <summary> The ETag property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.SelectedNavigationProperties"> <summary> The selected navigation properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.SelectedStreamProperties"> <summary> The selected stream properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.SelectedBindableOperations"> <summary> The selected bindable operations. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.Create(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.Evaluation.IODataMetadataContext,Microsoft.OData.SelectedPropertiesNode,Microsoft.OData.Evaluation.ODataMetadataSelector,System.Boolean)"> <summary> Creates an instance of <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext"/>. </summary> <param name="resource">The resource instance.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource.</param> <param name="serializationInfo">The serialization info of the resource for writing without model.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="metadataContext">The metadata context to use.</param> <param name="selectedProperties">The selected properties.</param> <param name="metadataSelector">Informs the metadata builder which properties, functions, actions, links to omit.</param> <param name="requiresId">True if the resource requires an id, false if it is a non-deleted resource in a delta request payload.</param> <returns>A new instance of <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext"/>.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.GetKeyProperties(Microsoft.OData.ODataResourceBase,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmEntityType,System.Boolean)"> <summary> Get key value pair array for specific odata resource using specific entity type </summary> <param name="resource">The resource instance.</param> <param name="serializationInfo">The serialization info of the resource for writing without model.</param> <param name="actualEntityType">The edm entity type of the resource</param> <param name="requiresId">Whether key properties are required to be returned</param> <returns>Key value pair list.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.TryGetPrimitiveOrEnumPropertyValue(Microsoft.OData.ODataResourceBase,System.String,Microsoft.OData.Edm.IEdmStructuredType,System.Boolean,System.Object@)"> <summary> Gets the value for a primitive or enum property. </summary> <param name="resource">The resource to get the property value.</param> <param name="propertyName">Name of the property.</param> <param name="entityType">The entity type of the resource.</param> <param name="isRequired">true, if the property value is required to be non-null.</param> <param name="value">returned value, or null if no value is found.</param> <returns>true, if the primitive value is found, otherwise false.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.GetPrimitiveOrEnumPropertyValue(Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.ODataProperty,System.Boolean)"> <summary> Gets the value for a primitive or enum property. For primitive type, returns its CLR value; for enum type, returns OData enum value. </summary> <param name="resource">The resource from which the property was retrieved.</param> <param name="entityType">The entity type used to get the property value.</param> <param name="property">The ODataProperty to get the value from.</param> <param name="validateNotNull">true if property must not be null, false otherwise.</param> <returns>The value of the property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ValidateEntityTypeHasKeyProperties(System.Collections.Generic.IList{System.Collections.Generic.KeyValuePair{System.String,System.Object}},Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmStructuredType,System.Boolean)"> <summary> Validates that the resource has key properties. </summary> <param name="keyProperties">Key properties of the resource.</param> <param name="resource">The resource that contains the properties.</param> <param name="actualEntityType">The type of the resource.</param> <param name="throwOnError">Whether to throw if validation fails.</param> <returns>True, if validation succeeds, or false if validation fails.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.GetPropertiesBySerializationInfoPropertyKind(Microsoft.OData.ODataResourceBase,Microsoft.OData.ODataPropertyKind,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Gets the property name value pairs filtered by serialization property kind. </summary> <param name="resource">The resource to get the properties from.</param> <param name="propertyKind">The serialization info property kind.</param> <param name="actualEntityType">The entity type of the resource.</param> <returns>The property name value pairs filtered by serialization property kind.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.GetResourceTypeName(Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Gets the resource type name of the specified resource. </summary> <param name="resource">The resource instance.</param> <param name="resourceType">The resource's type.</param> <returns>The name of the resource's type.</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel"> <summary> Implementation of <see cref="T:Microsoft.OData.Evaluation.IODataResourceMetadataContext"/> based on serialization info. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.EmptyNavigationProperties"> <summary> Empty array of navigation properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.EmptyStreamProperties"> <summary> Empty dictionary of stream properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.EmptyOperations"> <summary> Empty array of operations. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.requiresId"> <summary> True if the resource requires an id, false if it is a non-deleted resource in a delta request payload. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.serializationInfo"> <summary> The serialization info of the resource for writing without model. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.#ctor(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,System.Boolean)"> <summary> Constructs an instance of <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel"/>. </summary> <param name="resource">The resource instance.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource.</param> <param name="serializationInfo">The serialization info of the resource for writing without model.</param> <param name="requiresId">True if the resource requires an id, false if it is a non-deleted resource in a delta request payload.</param> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.KeyProperties"> <summary> The key property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.ETagProperties"> <summary> The ETag property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.ActualResourceTypeName"> <summary> The actual structured type of the resource, i.e. ODataResource.TypeName. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.SelectedNavigationProperties"> <summary> The selected navigation properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.SelectedStreamProperties"> <summary> The selected stream properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithoutModel.SelectedBindableOperations"> <summary> The selected bindable operations. </summary> </member> <member name="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel"> <summary> Implementation of <see cref="T:Microsoft.OData.Evaluation.IODataResourceMetadataContext"/> based on the given model. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.actualResourceType"> <summary> The structured type of the resource. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.metadataContext"> <summary> The metadata context to use. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.selectedProperties"> <summary> The selected properties. </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.metadataSelector"> <summary> The metadata selector </summary> </member> <member name="F:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.requiresId"> <summary> True if the resource requires an id, false if it is a non-deleted resource in a delta request payload. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.#ctor(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.Evaluation.IODataMetadataContext,Microsoft.OData.SelectedPropertiesNode,Microsoft.OData.Evaluation.ODataMetadataSelector,System.Boolean)"> <summary> Constructs an instance of <see cref="T:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel"/>. </summary> <param name="resource">The resource instance.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="metadataContext">The metadata context to use.</param> <param name="selectedProperties">The selected properties.</param> <param name="metadataSelector">The metadata selector to use when writing metadata.</param> <param name="requiresId">True if the resource requires an id, false if it is a non-deleted resource in a delta request payload.</param> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.KeyProperties"> <summary> The key property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.ETagProperties"> <summary> The ETag property name and value pairs of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.ActualResourceTypeName"> <summary> The actual structured type name of the resource. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.SelectedNavigationProperties"> <summary> The selected navigation properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.SelectedStreamProperties"> <summary> The selected stream properties. </summary> </member> <member name="P:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.SelectedBindableOperations"> <summary> The selected bindable operations. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataResourceMetadataContext.ODataResourceMetadataContextWithModel.ComputeETagPropertiesFromAnnotation"> <summary> Compute ETag from Annotation Org.OData.Core.V1.OptimisticConcurrency on EntitySet </summary> <returns>Enumerable of IEdmStructuralProperty</returns> </member> <member name="T:Microsoft.OData.Evaluation.ODataUriBuilder"> <summary> Extensibility point for customizing how OData URIs are built. </summary> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildBaseUri"> <summary> Builds the base URI for the entity container. </summary> <returns> The base URI for the entity container. This can be either an absolute URI, or relative URI which will be combined with the URI of the metadata document for the service. null if the model doesn't have the service base URI annotation. </returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildEntitySetUri(System.Uri,System.String)"> <summary> Builds the URI for an entity set. </summary> <param name="baseUri">The URI to append to.</param> <param name="entitySetName">The entity set name.</param> <returns>The entity set URI.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildEntityInstanceUri(System.Uri,System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.String)"> <summary> Builds the entity instance URI with the given key property values. </summary> <param name="baseUri">The URI to append to.</param> <param name="keyProperties">The list of name value pair for key properties.</param> <param name="entityTypeName">The full name of the entity type we are building the key expression for.</param> <returns>The entity instance URI.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildStreamEditLinkUri(System.Uri,System.String)"> <summary> Builds the edit link for a stream property. </summary> <param name="baseUri">The URI to append to.</param> <param name="streamPropertyName"> The name of the stream property the link is computed for; or null for the default media resource. </param> <returns>The edit link for the stream.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildStreamReadLinkUri(System.Uri,System.String)"> <summary> Builds the read link for a stream property. </summary> <param name="baseUri">The URI to append to.</param> <param name="streamPropertyName"> The name of the stream property the link is computed for; or null for the default media resource. </param> <returns>The read link for the stream.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildNavigationLinkUri(System.Uri,System.String)"> <summary> Builds the navigation link for the navigation property. </summary> <param name="baseUri">The URI to append to.</param> <param name="navigationPropertyName">The name of the navigation property to get the navigation link URI for.</param> <returns>The navigation link URI for the navigation property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildAssociationLinkUri(System.Uri,System.String)"> <summary> Builds the association link for the navigation property. </summary> <param name="baseUri">The URI to append to.</param> <param name="navigationPropertyName">The name of the navigation property to get the association link URI for.</param> <returns>The association link URI for the navigation property.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.BuildOperationTargetUri(System.Uri,System.String,System.String,System.String)"> <summary> Builds the operation target URI for the specified <paramref name="operationName"/>. </summary> <param name="baseUri">The URI to append to.</param> <param name="operationName">The fully qualified name of the operation for which to get the target URI.</param> <param name="bindingParameterTypeName">The binding parameter type name to include in the target, or null/empty if there is none.</param> <param name="parameterNames">The parameter names to include in the target, or null/empty if there is none.</param> <returns>The target URI for the operation.</returns> </member> <member name="M:Microsoft.OData.Evaluation.ODataUriBuilder.AppendTypeSegment(System.Uri,System.String)"> <summary> Builds a URI with the given type name appended as a new segment on the base URI. </summary> <param name="baseUri">The URI to append to.</param> <param name="typeName">The fully qualified type name to append.</param> <returns>The URI with the type segment appended.</returns> </member> <member name="T:Microsoft.OData.ExceptionUtils"> <summary> Class with utility methods to work with exceptions </summary> </member> <member name="F:Microsoft.OData.ExceptionUtils.OutOfMemoryType"> <summary>Type of OutOfMemoryException.</summary> </member> <member name="M:Microsoft.OData.ExceptionUtils.IsCatchableExceptionType(System.Exception)"> <summary> Determines whether the specified exception can be caught and handled, or whether it should be allowed to continue unwinding. </summary> <param name="e"><see cref="T:System.Exception"/> to test.</param> <returns> true if the specified exception can be caught and handled; false otherwise. </returns> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckArgumentNotNull``1(``0,System.String)"> <summary> Checks the argument value for null and throws <see cref="T:System.ArgumentNullException"/> if it is null. </summary> <typeparam name="T">Type of the argument, used to force usage only for reference types.</typeparam> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> <returns>The value</returns> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckArgumentStringNotEmpty(System.String,System.String)"> <summary> Checks the argument string value empty string and throws <see cref="T:System.ArgumentNullException"/> if it is empty. The value can be null though. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckArgumentStringNotNullOrEmpty(System.String,System.String)"> <summary> Checks the argument string value for null or empty string and throws <see cref="T:System.ArgumentNullException"/> if it is null or empty. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckIntegerNotNegative(System.Int32,System.String)"> <summary> Checks the <paramref name="value"/> for not being negative and throws <see cref="T:System.ArgumentOutOfRangeException"/> if it is negative. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckIntegerPositive(System.Int32,System.String)"> <summary> Checks the <paramref name="value"/> for being greater than zero and throws <see cref="T:System.ArgumentOutOfRangeException"/> if it is not positive. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckLongPositive(System.Int64,System.String)"> <summary> Checks the <paramref name="value"/> for being greater than zero and throws <see cref="T:System.ArgumentOutOfRangeException"/> if it is not positive. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> </member> <member name="M:Microsoft.OData.ExceptionUtils.CheckArgumentCollectionNotNullOrEmpty``1(System.Collections.Generic.ICollection{``0},System.String)"> <summary> Checks the <paramref name="value"/> for not being empty. </summary> <param name="value">Argument whose value needs to be checked.</param> <param name="parameterName">Name of the argument, used for exception message.</param> <typeparam name="T">Type of the collection. It does not matter.</typeparam> </member> <member name="T:Microsoft.OData.ExceptionUtils.ValidatedNotNullAttribute"> <summary> A workaround to a problem with FxCop which does not recognize the CheckArgumentNotNull method as the one which validates the argument is not null. </summary> <remarks>This has been suggested as a workaround in msdn forums by the VS team. Note that even though this is production code the attribute has no effect on anything else.</remarks> </member> <member name="T:Microsoft.OData.GeographyTypeConverter"> <summary> Handles serialization and deserialization for types derived from Geography. </summary> </member> <member name="M:Microsoft.OData.GeographyTypeConverter.WriteAtom(System.Object,System.Xml.XmlWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an XmlWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The Xml writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.GeographyTypeConverter.WriteAtom(System.Object,System.IO.TextWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an TextWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The text writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.GeographyTypeConverter.WriteJsonLight(System.Object,Microsoft.OData.Json.IJsonWriter)"> <summary> Write the Json Lite representation of an instance of a primitive type to a json writer. </summary> <param name="instance">The instance to write.</param> <param name="jsonWriter">Instance of JsonWriter.</param> </member> <member name="T:Microsoft.OData.GeometryTypeConverter"> <summary> Handles serialization and deserialization for types derived from Geometry. This file is currently compiled by ODataLib and Astoria server, because it contains functionality related to both serialization and deserialization, but deserialization is not yet integrated into Astoria. Once that integration happens this functionality should be fully contained within ODataLib only. </summary> </member> <member name="M:Microsoft.OData.GeometryTypeConverter.WriteAtom(System.Object,System.Xml.XmlWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an XmlWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The Xml writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.GeometryTypeConverter.WriteAtom(System.Object,System.IO.TextWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an TextWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The text writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.GeometryTypeConverter.WriteJsonLight(System.Object,Microsoft.OData.Json.IJsonWriter)"> <summary> Write the Json Lite representation of an instance of a primitive type to a json object. </summary> <param name="instance">The instance to write.</param> <param name="jsonWriter">Instance of JsonWriter.</param> </member> <member name="T:Microsoft.OData.HttpHeaderValue"> <summary> Extension methods for http header values. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValue.#ctor"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValue"/>. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValue.ToString"> <summary> Returns the HTTP header value string which can be used to set the header on the request and response messages. </summary> <returns>Returns the HTTP header value string which can be used to set the header on the request and response messages.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueElement"> <summary> Class to represent a HTTP header value element. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueElement.#ctor(System.String,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <summary> Initializes a new instance of the <see cref="T:Microsoft.OData.HttpHeaderValueElement"/> class. </summary> <param name="name">The name of the preference.</param> <param name="value">The value of the preference.</param> <param name="parameters">The enumeration of preference parameter key value pairs.</param> </member> <member name="P:Microsoft.OData.HttpHeaderValueElement.Name"> <summary> The name of the preference. </summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueElement.Value"> <summary> The value of the preference. </summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueElement.Parameters"> <summary> The enumeration of preference parameter key value pairs. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueElement.ToString"> <summary> Converts the current <see cref="T:Microsoft.OData.HttpHeaderValueElement"/> to string. </summary> <returns>The string for <see cref="T:Microsoft.OData.HttpHeaderValueElement"/>.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueElement.AppendNameValuePair(System.Text.StringBuilder,System.String,System.String)"> <summary> Appends the <paramref name="name"/> and <paramref name="value"/> to <paramref name="stringBuilder"/> as name=value. </summary> <param name="stringBuilder">The string builder to append to.</param> <param name="name">The name to append.</param> <param name="value">The value to append.</param> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer"> <summary> Lexer to parse HTTP header values. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.ElementSeparator"> <summary> The ',' separator. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.ParameterSeparator"> <summary> The ';' separator. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.ValueSeparator"> <summary> The '=' separator. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.httpHeaderName"> <summary> The name of the HTTP header being parsed. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.httpHeaderValue"> <summary> The value of the HTTP header being parsed. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.startIndexOfNextItem"> <summary> The starting index to the next item to be parsed. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.value"> <summary> The value of the current parsed item. If the item type is quoted-string, this returns the unescaped and unquoted string value. For other item types, the value is the same as the original text from the header. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.originalText"> <summary> The original text of the current parsed item. If the item type is quoted-string, this returns the escaped and quoted string value straight from the header. For other item types, the original text is the same as the item value. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.#ctor(System.String,System.String,System.String,System.String,System.Int32)"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/>. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> <param name="value">The value of the current parsed item. If the item type is quoted-string, this returns the unescaped and unquoted string value. For other item types, the value is the same as the original text from the header.</param> <param name="originalText">The original text of the current parsed item. If the item type is quoted-string, this returns the escaped and quoted string value straight from the header. For other item types, the original text is the same as the item value.</param> <param name="startIndexOfNextItem">The start index of the next item to be parsed.</param> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType"> <summary> The item type enum. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.Start"> <summary>Currently at the start of the header value.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.Token"> <summary>The current item is a token.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.QuotedString"> <summary>The current item is a quoted-string.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.ElementSeparator"> <summary>The current item is the header element separator ','.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.ParameterSeparator"> <summary>The current item is the parameter separator ';'.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.ValueSeparator"> <summary>The current item is the value separator '='.</summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderValueItemType.End"> <summary>At the end of the header value.</summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.Value"> <summary> The value of the current parsed item. If the item type is quoted-string, this returns the unescaped and unquoted string value. For other item types, the value is the same as the original text from the header. </summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.OriginalText"> <summary> The original text of the current parsed item. If the item type is quoted-string, this returns the escaped and quoted string value straight from the header. For other item types, the original text is the same as the item value. </summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.Type"> <summary> The type of the current parsed item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.Create(System.String,System.String)"> <summary> Constructs a new instance of the HTTP header value item. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> <returns>The newly created instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/>.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ToHttpHeaderValue"> <summary> Reads the content of a HTTP header from this <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> instance to a new <see cref="T:Microsoft.OData.HttpHeaderValue"/> instance. </summary> <returns>A new <see cref="T:Microsoft.OData.HttpHeaderValue"/> instance populated with the content from this <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> instance.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadHttpHeaderValueElement(Microsoft.OData.HttpHeaderValueLexer@)"> <summary> Reads a <see cref="T:Microsoft.OData.HttpHeaderValueElement"/> from <paramref name="lexer"/> and advances the <paramref name="lexer"/> forward. </summary> <param name="lexer">The lexer to read from.</param> <returns>The <see cref="T:Microsoft.OData.HttpHeaderValueElement"/> that was read.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadKeyValuePair(Microsoft.OData.HttpHeaderValueLexer@)"> <summary> Reads a token or token=(token|quoted-string) from the <paramref name="lexer"/>, convert it to a key value pair and advances the <paramref name="lexer"/>. </summary> <param name="lexer">The lexer to read from.</param> <returns>The converted key value pair.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.EndOfHeaderValue"> <summary> Returns true if we've parsed to the end of the header value, false otherwise. </summary> <returns>Returns true if we've parsed to the end of the header value, false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadNextTokenOrQuotedString"> <summary> Reads a token or quoted-string value from the header. </summary> <returns>The token or quoted-string value that was read from the header.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadNextToken"> <summary> Reads a token from the header. </summary> <returns>The token item that was read from the header.</returns> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.ReadNextSeparator"> <summary> Reads a separator from the header. </summary> <returns>The separator item that was read from the header.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderStart"> <summary> Represents the start of the http header value. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderStart.#ctor(System.String,System.String)"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderStart"/>. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderStart.Type"> <summary> The type of the current item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderStart.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderToken"> <summary> Represents a token in the HTTP header value. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderToken.#ctor(System.String,System.String,System.String,System.Int32)"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderToken"/>. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> <param name="value">The value of the token.</param> <param name="startIndexOfNextItem">The start index of the next item.</param> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderToken.Type"> <summary> The type of the current item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderToken.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderQuotedString"> <summary> Represents a quoted-string in the HTTP header value. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderQuotedString.#ctor(System.String,System.String,System.String,System.String,System.Int32)"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderQuotedString"/>. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> <param name="value">The value of the quoted string, unescaped and without quotes.</param> <param name="originalText">The original text of the quoted string, escaped and with quotes.</param> <param name="startIndexOfNextItem">The start index of the next item.</param> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderQuotedString.Type"> <summary> The type of the current item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderQuotedString.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderSeparator"> <summary> Represents a separator in the HTTP header value. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderSeparator.#ctor(System.String,System.String,System.String,System.Int32)"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderSeparator"/>. </summary> <param name="httpHeaderName">The name of the HTTP header being parsed.</param> <param name="httpHeaderValue">The value of the HTTP header being parsed.</param> <param name="value">The value of the separator.</param> <param name="startIndexOfNextItem">The start index of the next item.</param> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderSeparator.Type"> <summary> The type of the current item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderSeparator.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd"> <summary> Represents the end of the http header value. </summary> </member> <member name="F:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd.Instance"> <summary> Static instance of the end item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd.#ctor"> <summary> Constructs a new instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd"/>. </summary> </member> <member name="P:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd.Type"> <summary> The type of the current item. </summary> </member> <member name="M:Microsoft.OData.HttpHeaderValueLexer.HttpHeaderEnd.ReadNext"> <summary> Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value. Parsing is based on this grammar: header = "header-name" ":" 1#element element = token [ BWS "=" BWS (token | quoted-string) ] *( OWS ";" [ OWS parameter ] ) parameter = token [ BWS "=" BWS (token | quoted-string) ] </summary> <returns>Returns an instance of <see cref="T:Microsoft.OData.HttpHeaderValueLexer"/> to parse the rest of the items on the header value.</returns> </member> <member name="T:Microsoft.OData.HttpUtils"> <summary> Class with utility methods to work with HTTP concepts </summary> </member> <member name="M:Microsoft.OData.HttpUtils.ReadMimeType(System.String,System.String@,System.String@)"> <summary>Reads a Content-Type header and extracts the media type's name (type/subtype) and parameters.</summary> <param name="contentType">The Content-Type header.</param> <param name="mediaTypeName">The media type in standard type/subtype form, without parameters.</param> <param name="mediaTypeCharset">The (optional) charset parameter of the media type.</param> <returns>The parameters of the media type not including the 'charset' parameter.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.BuildContentType(Microsoft.OData.ODataMediaType,System.Text.Encoding)"> <summary>Builds a Content-Type header which includes media type and encoding information.</summary> <param name="mediaType">Media type to be used.</param> <param name="encoding">Encoding to be used in response, possibly null.</param> <returns>The value for the Content-Type header.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.MediaTypesFromString(System.String)"> <summary>Returns all media types from the specified (non-blank) <paramref name='text' />.</summary> <param name='text'>Non-blank text, as it appears on an HTTP Accepts header.</param> <returns>An enumerable object with key/value pairs of media type descriptions with their (optional) charset parameter values.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.CompareMediaTypeNames(System.String,System.String)"> <summary> Does an ordinal ignore case comparision of the given media type names. </summary> <param name="mediaTypeName1">First media type name.</param> <param name="mediaTypeName2">Second media type name.</param> <returns>returns true if the media type names are the same.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.CompareMediaTypeParameterNames(System.String,System.String)"> <summary> Does an ordinal ignore case comparision of the given MIME type parameter name. </summary> <param name="parameterName1">First parameter name.</param> <param name="parameterName2">Second parameter name.</param> <returns>returns true if the parameter names are the same.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.IsMetadataParameter(System.String)"> <summary> Determines whether or not a parameter is the odata metadata parameter. </summary> <param name="parameterName">The name of the parameter.</param> <returns>returns true if the parameter name is the odata metadata parameter.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.IsStreamingParameter(System.String)"> <summary> Determines whether or not a parameter is the odata streaming parameter. </summary> <param name="parameterName">The name of the parameter.</param> <returns>returns true if the parameter name is the odata streaming parameter.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.EncodingFromAcceptableCharsets(System.String,Microsoft.OData.ODataMediaType,System.Text.Encoding,System.Text.Encoding)"> <summary>Gets the best encoding available for the specified charset request.</summary> <param name="acceptableCharsets"> The Accept-Charset header value (eg: "iso-8859-5, unicode-1-1;q=0.8"). </param> <param name="mediaType">The media type used to compute the default encoding for the payload.</param> <param name="utf8Encoding">The encoding to use for UTF-8 charsets; we use the one without the BOM.</param> <param name="defaultEncoding">The encoding to use if no encoding could be computed from the <paramref name="acceptableCharsets"/> or <paramref name="mediaType"/>.</param> <returns>An Encoding object appropriate to the specified charset request.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.ReadQualityValue(System.String,System.Int32@,System.Int32@)"> <summary> Reads the numeric part of a quality value substring, normalizing it to 0-1000 rather than the standard 0.000-1.000 ranges. </summary> <param name="text">Text to read qvalue from.</param> <param name="textIndex">Index into text where the qvalue starts.</param> <param name="qualityValue">After the method executes, the normalized qvalue.</param> <remarks> For more information, see RFC 2616.3.8. </remarks> </member> <member name="M:Microsoft.OData.HttpUtils.ValidateHttpMethod(System.String)"> <summary> Validates that the HTTP method string matches one of the supported HTTP methods. </summary> <param name="httpMethodString">The HTTP method string to validate.</param> </member> <member name="M:Microsoft.OData.HttpUtils.IsQueryMethod(System.String)"> <summary> Determines whether the given HTTP method is one that is accepted for queries. GET is accepted for queries. </summary> <param name="httpMethod">The HTTP method to check.</param> <returns>True if the given httpMethod is GET.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.GetStatusMessage(System.Int32)"> <summary> Gets the string status message for a given Http response status code. </summary> <param name="statusCode">The status code to get the status message for.</param> <returns>The string status message for the <paramref name="statusCode"/>.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.GetEncodingFromCharsetName(System.String)"> <summary> Returns the encoding object for the specified charset name. </summary> <param name="charsetName">The of the charset to get the encoding for.</param> <returns>The encoding object or null if such encoding is not supported.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.ReadTokenOrQuotedStringValue(System.String,System.String,System.Int32@,System.Boolean@,System.Func{System.String,System.Exception})"> <summary> Reads a token or quoted-string value from the header. </summary> <param name="headerName">Name of the header.</param> <param name="headerText">Header text.</param> <param name="textIndex">Parsing index in <paramref name="headerText"/>.</param> <param name="isQuotedString">Returns true if the value is a quoted-string, false if the value is a token.</param> <param name="createException">Func to create the appropriate exception to throw from the given error message.</param> <returns>The token or quoted-string value that was read from the header.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.SkipWhitespace(System.String,System.Int32@)"> <summary> Skips whitespace in the specified text by advancing an index to the next non-whitespace character. </summary> <param name="text">Text to scan.</param> <param name="textIndex">Index to begin scanning from.</param> <returns>true if the end of the string was reached, false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.AcceptCharsetParts(System.String)"> <summary> Enumerates each charset part in the specified Accept-Charset header. </summary> <param name="headerValue">Non-null and non-empty header value for Accept-Charset.</param> <returns> A (non-sorted) enumeration of CharsetPart elements, which include a charset name and a quality (preference) value, normalized to 0-1000. </returns> </member> <member name="M:Microsoft.OData.HttpUtils.ReadMediaTypes(System.String)"> <summary>Reads a media type definition as used in a Content-Type header.</summary> <param name="text">Text to read.</param> <returns>A list of key/value pairs representing the <see cref="T:Microsoft.OData.ODataMediaType"/>s and their (optional) 'charset' parameters parsed from the specified <paramref name="text"/></returns> </member> <member name="M:Microsoft.OData.HttpUtils.ReadMediaTypeParameter(System.String,System.Int32@,System.Collections.Generic.List{System.Collections.Generic.KeyValuePair{System.String,System.String}}@,System.String@)"> <summary>Read a parameter for a media type/range.</summary> <param name="text">Text to read from.</param> <param name="textIndex">Pointer in text.</param> <param name="parameters">Array with parameters to grow as necessary.</param> <param name="charset">The (optional) charset parameter value.</param> </member> <member name="M:Microsoft.OData.HttpUtils.ReadMediaTypeAndSubtype(System.String,System.Int32@,System.String@,System.String@)"> <summary>Reads the type and subtype specifications for a media type name.</summary> <param name='mediaTypeName'>Text in which specification exists.</param> <param name='textIndex'>Pointer into text.</param> <param name='type'>Type of media found.</param> <param name='subType'>Subtype of media found.</param> </member> <member name="M:Microsoft.OData.HttpUtils.IsHttpToken(System.Char)"> <summary> Determines whether the specified character is a valid HTTP header token character. </summary> <param name="c">Character to verify.</param> <returns>true if c is a valid HTTP header token character; false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.IsValidInQuotedHeaderValue(System.Char)"> <summary> Determines whether the specified character is valid in the quoted header values. </summary> <param name="c">Character to verify.</param> <returns>true if c is a valid in a quoted HTTP header value; false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.IsHttpSeparator(System.Char)"> <summary> Determines whether the specified character is a valid HTTP separator. </summary> <param name="c">Character to verify.</param> <returns>true if c is a separator; false otherwise.</returns> <remarks> See RFC 2616 2.2 for further information. </remarks> </member> <member name="M:Microsoft.OData.HttpUtils.ReadToken(System.String,System.Int32@)"> <summary> Reads a token on the specified text by advancing an index on it. </summary> <param name="text">Text to read token from.</param> <param name="textIndex">Index for the position being scanned on text.</param> <returns>true if the end of the text was reached; false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.DigitToInt32(System.Char)"> <summary> Converts the specified character from the ASCII range to a digit. </summary> <param name="c">Character to convert.</param> <returns> The Int32 value for c, or -1 if it is an element separator. </returns> </member> <member name="M:Microsoft.OData.HttpUtils.IsHttpElementSeparator(System.Char)"> <summary> Verifies whether the specified character is a valid separator in an HTTP header list of element. </summary> <param name="c">Character to verify.</param> <returns>true if c is a valid character for separating elements; false otherwise.</returns> </member> <member name="M:Microsoft.OData.HttpUtils.ReadLiteral(System.String,System.Int32,System.String)"> <summary> "Reads" a literal from the specified string by verifying that the exact text can be found at the specified position. </summary> <param name="text">Text within which a literal should be checked.</param> <param name="textIndex">Index in text where the literal should be found.</param> <param name="literal">Literal to check at the specified position.</param> <returns>true if the end of string is found; false otherwise.</returns> </member> <member name="T:Microsoft.OData.HttpUtils.CharsetPart"> <summary> Structure to represent a charset name with a quality value. </summary> </member> <member name="F:Microsoft.OData.HttpUtils.CharsetPart.Charset"> <summary>Name of the charset.</summary> </member> <member name="F:Microsoft.OData.HttpUtils.CharsetPart.Quality"> <summary>Charset quality (desirability), normalized to 0-1000.</summary> </member> <member name="M:Microsoft.OData.HttpUtils.CharsetPart.#ctor(System.String,System.Int32)"> <summary> Initializes a new CharsetPart with the specified values. </summary> <param name="charset">Name of charset.</param> <param name="quality">Charset quality (desirability), normalized to 0-1000.</param> </member> <member name="T:Microsoft.OData.IContainerBuilder"> <summary> An interface that decouples ODataLib from any implementation of dependency injection container. </summary> </member> <member name="M:Microsoft.OData.IContainerBuilder.AddService(Microsoft.OData.ServiceLifetime,System.Type,System.Type)"> <summary> Adds a service of <paramref name="serviceType"/> with an <paramref name="implementationType"/>. </summary> <param name="lifetime">The lifetime of the service to register.</param> <param name="serviceType">The type of the service to register.</param> <param name="implementationType">The implementation type of the service.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.IContainerBuilder.AddService(Microsoft.OData.ServiceLifetime,System.Type,System.Func{System.IServiceProvider,System.Object})"> <summary> Adds a service of <paramref name="serviceType"/> with an <paramref name="implementationFactory"/>. </summary> <param name="lifetime">The lifetime of the service to register.</param> <param name="serviceType">The type of the service to register.</param> <param name="implementationFactory">The factory that creates the service.</param> <returns>The <see cref="T:Microsoft.OData.IContainerBuilder"/> instance itself.</returns> </member> <member name="M:Microsoft.OData.IContainerBuilder.BuildContainer"> <summary> Builds a container which implements <see cref="T:System.IServiceProvider"/> and contains all the services registered. </summary> <returns>The container built by this builder.</returns> </member> <member name="T:Microsoft.OData.IContainerProvider"> <summary> An interface that provides a dependency injection container. </summary> </member> <member name="P:Microsoft.OData.IContainerProvider.Container"> <summary> Gets a container which implements <see cref="T:System.IServiceProvider"/> and contains all the services registered. </summary> </member> <member name="T:Microsoft.OData.IDuplicatePropertyNameChecker"> <summary> Validates that 1) No duplicate property. 2) No duplicate "@odata.associationLink" on a property. 3) "@odata.associationLink"s are put on navigation properties. </summary> </member> <member name="M:Microsoft.OData.IDuplicatePropertyNameChecker.ValidatePropertyUniqueness(Microsoft.OData.ODataPropertyInfo)"> <summary> Validates property uniqueness. </summary> <param name="property">The property.</param> </member> <member name="M:Microsoft.OData.IDuplicatePropertyNameChecker.ValidatePropertyUniqueness(Microsoft.OData.ODataNestedResourceInfo)"> <summary> Validates property uniqueness. </summary> <param name="property">The property.</param> </member> <member name="M:Microsoft.OData.IDuplicatePropertyNameChecker.ValidatePropertyOpenForAssociationLink(System.String)"> <summary> Validates that "@odata.associationLink" is put on a navigation property, and that no duplicate exists. </summary> <param name="propertyName">Name of the property.</param> </member> <member name="M:Microsoft.OData.IDuplicatePropertyNameChecker.Reset"> <summary> Resets to initial state for reuse. </summary> </member> <member name="T:Microsoft.OData.InstanceAnnotationWriteTracker"> <summary> Helper class to track if an annotation has been written. </summary> </member> <member name="F:Microsoft.OData.InstanceAnnotationWriteTracker.writeStatus"> <summary> Maintains the write status for each annotation using its key. If a key exists in the list then it is considered written. </summary> </member> <member name="M:Microsoft.OData.InstanceAnnotationWriteTracker.#ctor"> <summary> Creates a new <see cref="T:Microsoft.OData.InstanceAnnotationWriteTracker"/> to hold write status for instance annotations. </summary> </member> <member name="M:Microsoft.OData.InstanceAnnotationWriteTracker.IsAnnotationWritten(System.String)"> <summary> Check if an annotation is already written. </summary> <returns>true if the annotation is written; otherwise false.</returns> <param name="key">The key of the element to check if its written.</param> </member> <member name="M:Microsoft.OData.InstanceAnnotationWriteTracker.MarkAnnotationWritten(System.String)"> <summary> Mark an annotation as written. </summary> <returns>true if the annotation was unmarked before; otherwise false.</returns> <param name="key">The key of the element to mark as written.</param> </member> <member name="T:Microsoft.OData.InternalErrorCodes"> <summary> An enumeration that lists the internal errors. </summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataWriterCore_WriteEnd_UnreachableCodePath"> <summary>Unreachable codepath in ODataWriterCore.WriteEnd</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataWriterCore_ValidateTransition_UnreachableCodePath"> <summary>Unreachable codepath in ODataWriterCore.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataWriterCore_Scope_Create_UnreachableCodePath"> <summary>Unreachable codepath in ODataWriterCore.Scope.Create</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataWriterCore_PropertyAndAnnotationCollector"> <summary>Unreachable codepath in ODataWriterCore.PropertyAndAnnotationCollector.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataWriterCore_ParentNestedResourceInfoScope"> <summary>Unreachable codepath in ODataWriterCore.ParentNestedResourceInfoScope.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataUtils_VersionString_UnreachableCodePath"> <summary>Unreachable codepath in ODataUtils.VersionString</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataUtilsInternal_IsPayloadKindSupported_UnreachableCodePath"> <summary>Unreachable codepath in ODataUtilsInternal.IsPayloadKindSupported</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataUtils_GetDefaultEncoding_UnreachableCodePath"> <summary>Unreachable codepath in ODataUtils.GetDefaultEncoding</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteProperty"> <summary>Unreachable codepath in ODataMessageWriter.WriteProperty</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteEntityReferenceLink"> <summary>Unreachable codepath in ODataMessageWriter.WriteEntityReferenceLink</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteEntityReferenceLinks"> <summary>Unreachable codepath in ODataMessageWriter.WriteEntityReferenceLinks</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteError"> <summary>Unreachable codepath in ODataMessageWriter.WriteError</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteServiceDocument"> <summary>Unreachable codepath in ODataMessageWriter.WriteServiceDocument</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMessageWriter_WriteMetadataDocument"> <summary>Unreachable codepath in ODataMessageWriter.WriteMetadataDocument</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionWriter_CreateCollectionWriter_UnreachableCodePath"> <summary>Unreachable codepath in ODataCollectionWriter.CreateCollectionWriter</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionWriterCore_ValidateTransition_UnreachableCodePath"> <summary>Unreachable codepath in ODataCollectionWriterCore.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionWriterCore_WriteEnd_UnreachableCodePath"> <summary>Unreachable codepath in ODataCollectionWriterCore.WriteEnd</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriter_CannotCreateParameterWriterForFormat"> <summary>Unreachable codepath in ODataParameterWriter.CreateParameterWriter</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_InvalidTransitionFromStart"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_InvalidTransitionFromCanWriteParameter"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_InvalidTransitionFromActiveSubWriter"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_InvalidTransitionFromCompleted"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_InvalidTransitionFromError"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_ValidateTransition_UnreachableCodePath"> <summary>Unreachable codepath in ODataParameterWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterWriterCore_WriteEndImplementation_UnreachableCodePath"> <summary>Unreachable codepath in ODataParameterWriter.WriteEndImplementation</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.QueryPathValidator_ValidateSegment_Root"> <summary>Unreachable codepath in ODataPathValidator.ValidateSegment root branch</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.QueryPathValidator_ValidateSegment_NonRoot"> <summary>Unreachable codepath in ODataPathValidator.ValidateSegment non-root branch</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchWriter_ValidateTransition_UnreachableCodePath"> <summary>Unreachable codepath in ODataBatchWriter.ValidateTransition</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchWriterUtils_HttpMethod_ToText_UnreachableCodePath"> <summary>Unreachable codepath in ODataBatchWriter.ToText(this HttpMethod).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReader_ReadImplementation"> <summary>Unreachable codepath in ODataBatchReader.ReadImplementation.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReader_GetEndBoundary_Completed"> <summary>Unreachable codepath in ODataBatchReader.GetEndBoundary in state Completed.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReader_GetEndBoundary_Exception"> <summary>Unreachable codepath in ODataBatchReader.GetEndBoundary in state Exception.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReader_GetEndBoundary_UnknownValue"> <summary>Unreachable codepath in ODataBatchReader.GetEndBoundary because of invalid enum value.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReaderStream_SkipToBoundary"> <summary>Unreachable codepath in ODataBatchReaderStream.SkipToBoundary.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReaderStream_ReadLine"> <summary>Unreachable codepath in ODataBatchReaderStream.ReadLine.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReaderStream_ReadWithDelimiter"> <summary>Unreachable codepath in ODataBatchReaderStream.ReadWithDelimiter.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReaderStreamBuffer_ScanForBoundary"> <summary>Unreachable codepath in ODataBatchReaderStreamBuffer.ScanForBoundary.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataBatchReaderStreamBuffer_ReadWithLength"> <summary>Unreachable codepath in ODataBatchReaderStreamBuffer.ReadWithLength.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.JsonReader_Read"> <summary>Unreachable codepath in JsonReader.Read.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataReader_CreateReader_UnreachableCodePath"> <summary>Unreachable codepath in ODataReader.CreateReader.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataReaderCore_ReadImplementation"> <summary>Unreachable codepath in ODataReaderCore.ReadImplementation.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataReaderCoreAsync_ReadAsynchronously"> <summary>Unreachable codepath in ODataReaderCoreAsync.ReadAsynchronously.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionReader_CreateReader_UnreachableCodePath"> <summary>Unreachable codepath in ODataCollectionReader.CreateReader.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionReaderCore_ReadImplementation"> <summary>Unreachable codepath in ODataCollectionReaderCore.ReadImplementation.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataCollectionReaderCoreAsync_ReadAsynchronously"> <summary>Unreachable codepath in ODataCollectionReaderCoreAsync.ReadAsynchronously.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterReaderCore_ReadImplementation"> <summary>Unreachable codepath in ODataParameterReaderCore.ReadImplementation.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterReaderCoreAsync_ReadAsynchronously"> <summary>Unreachable codepath in ODataParameterReaderCoreAsync.ReadAsynchronously.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataParameterReaderCore_ValueMustBePrimitiveOrNull"> <summary>The value from the parameter reader must be a primitive value, or null</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataRawValueUtils_ConvertStringToPrimitive"> <summary>Unreachable codepath in ODataRawValueUtils.ConvertStringToPrimitive.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.EdmCoreModel_PrimitiveType"> <summary>Unreachable codepath in EdmCoreModel.PrimitiveType (unsupported type).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ReaderValidationUtils_ResolveAndValidateTypeName_Strict_TypeKind"> <summary>Unreachable codepath in ReaderValidationUtils.ResolveAndValidateTypeName in the strict branch, unexpected type kind.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ReaderValidationUtils_ResolveAndValidateTypeName_Lax_TypeKind"> <summary>Unreachable codepath in ReaderValidationUtils.ResolveAndValidateTypeName in the lax branch, unexpected type kind.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMetadataFormat_CreateOutputContextAsync"> <summary>The ODataMetadataFormat.CreateOutputContextAsync was called, but this method is not yet supported.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataMetadataFormat_CreateInputContextAsync"> <summary>The ODataMetadataFormat.CreateInputContextAsync was called, but this method is not yet supported.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataModelFunctions_UnsupportedMethodOrProperty"> <summary>An unsupported method or property has been called on the IDictionary implementation of the ODataModelFunctions.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightPropertyAndValueDeserializer_ReadPropertyValue"> <summary>Unreachable codepath in ODataJsonLightPropertyAndValueDeserializer.ReadPropertyValue.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightPropertyAndValueDeserializer_GetNonEntityValueKind"> <summary>Unreachable codepath in ODataJsonLightPropertyAndValueDeserializer.GetNonEntityValueKind.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightReader_ReadResourceStart"> <summary>Unreachable codepath in ODataJsonLightReader.ReadResourceStart.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightResourceDeserializer_ReadTopLevelResourceSetAnnotations"> <summary>Unreachable codepath in ODataJsonLightResourceDeserializer.ReadTopLevelResourceSetAnnotations.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightCollectionDeserializer_ReadCollectionStart"> <summary>Unreachable codepath in ODataJsonLightCollectionDeserializer.ReadCollectionStart.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightCollectionDeserializer_ReadCollectionStart_TypeKindFromPayloadFunc"> <summary>Unreachable codepath in ODataJsonLightCollectionDeserializer.ReadCollectionStart.TypeKindFromPayloadFunc.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightCollectionDeserializer_ReadCollectionEnd"> <summary>Unreachable codepath in ODataJsonLightCollectionDeserializer.ReadCollectionEnd.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightEntityReferenceLinkDeserializer_ReadSingleEntityReferenceLink"> <summary>Unreachable codepath in ODataJsonLightEntityReferenceLinkDeserializer.ReadSingleEntityReferenceLink.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightEntityReferenceLinkDeserializer_ReadEntityReferenceLinksAnnotations"> <summary>Unreachable codepath in ODataJsonLightEntityReferenceLinkDeserializer.ReadEntityReferenceLinksAnnotations.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataJsonLightParameterDeserializer_ReadNextParameter"> <summary>Unreachable codepath in ODataJsonLightParameterDeserializer.ReadNextParameter.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.EdmTypeWriterResolver_GetReturnTypeForOperationImportGroup"> <summary>Unreachable codepath in EdmTypeWriterResolver.GetReturnType for operation import group.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodes.ODataVersionCache_UnknownVersion"> <summary>Unreachable codepath in the indexer of ODataVersionCache for unknown versions.</summary> </member> <member name="T:Microsoft.OData.InternalErrorCodesCommon"> <summary> An enumeration that lists the internal errors that are shared between the OData library and the query library. </summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_ToTypeReference"> <summary>Unreachable codepath in EdmLibraryExtensions.ToTypeReference (unsupported type kind).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_ToClrType"> <summary>Unreachable codepath in EdmLibraryExtensions.ToClrType (unsupported type kind).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_PrimitiveTypeReference"> <summary>Unreachable codepath in EdmLibraryExtensions.PrimitiveTypeReference (unsupported primitive type kind).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_IsAssignableFrom_Primitive"> <summary>Unreachable codepath in EdmLibraryExtensions.IsAssignableFrom(IEdmPrimitiveType, IEdmPrimitiveType).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_IsAssignableFrom_Type"> <summary>Unreachable codepath in EdmLibraryExtensions.IsAssignableFrom(IEdmType, IEdmType).</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_BaseType"> <summary>Unreachable codepath in EdmLibraryExtensions.BaseType.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_Clone_TypeKind"> <summary>Unreachable codepath in EdmLibraryExtensions.Clone for unexpected type kind.</summary> </member> <member name="F:Microsoft.OData.InternalErrorCodesCommon.EdmLibraryExtensions_Clone_PrimitiveTypeKind"> <summary>Unreachable codepath in EdmLibraryExtensions.Clone for unexpected primitive type kind.</summary> </member> <member name="T:Microsoft.OData.IODataOutputInStreamErrorListener"> <summary> An interface that allows the implementations of the writers to get notified if an in-stream error is to be written. </summary> </member> <member name="M:Microsoft.OData.IODataOutputInStreamErrorListener.OnInStreamError"> <summary> This method notifies the listener, that an in-stream error is to be written. </summary> <remarks> This listener can choose to fail, if the currently written payload doesn't support in-stream error at this position. If the listener returns, the writer should not allow any more writing, since the in-stream error is the last thing in the payload. </remarks> </member> <member name="M:Microsoft.OData.IODataOutputInStreamErrorListener.OnInStreamErrorAsync"> <summary> This method asynchronously notifies the listener, that an in-stream error is to be written. </summary> <remarks> This listener can choose to fail, if the currently written payload doesn't support in-stream error at this position. If the listener returns, the writer should not allow any more writing, since the in-stream error is the last thing in the payload. </remarks> <returns>A task that represents the asynchronous operation.</returns> </member> <member name="T:Microsoft.OData.IODataPayloadUriConverter"> <summary>Supports custom conversion of URLs found in the payload.</summary> <remarks> This interface can be implemented on messages (see <see cref="T:Microsoft.OData.IODataRequestMessage"/> and <see cref="T:Microsoft.OData.IODataResponseMessage"/>). When a message implementing this interface is passed to an <see cref="T:Microsoft.OData.ODataMessageWriter"/> or <see cref="T:Microsoft.OData.ODataMessageReader"/>, the message writer/reader will use this interface for custom URL conversion. On writers this means that whenever a URI is written into the payload the conversion method on this interface is called to convert a base URI and a payload URI to the actual URI to be written to the payload. If the method returns null from a conversion call the default conversion will be used. On readers this means that a base URI (either from the payload or the reader settings) and the URI read from the payload are passed to the method. The result is what is being reported on the OData OM instances. Again if the conversion method returns null the default conversion kicks in. </remarks> </member> <member name="M:Microsoft.OData.IODataPayloadUriConverter.ConvertPayloadUri(System.Uri,System.Uri)"> <summary>Implements a custom URL conversion scheme. This method returns null if no custom conversion is desired. If the method returns a non-null URL that value will be used without further validation.</summary> <returns>An instance that reflects the custom conversion of the method arguments into a URL or null if no custom conversion is desired; in that case the default conversion is used.</returns> <param name="baseUri">The (optional) base URI to use for the conversion.</param> <param name="payloadUri">The URI read from the payload.</param> </member> <member name="T:Microsoft.OData.IODataReaderWriterListener"> <summary> An interface that allows the creator of a reader/writer to listen for status changes of the created reader/writer. </summary> </member> <member name="M:Microsoft.OData.IODataReaderWriterListener.OnException"> <summary> This method notifies the implementer of this interface that the created reader is in Exception state. </summary> </member> <member name="M:Microsoft.OData.IODataReaderWriterListener.OnCompleted"> <summary> This method notifies the implementer of this interface that the created reader is in Completed state. </summary> </member> <member name="T:Microsoft.OData.IODataRequestMessage"> <summary> Interface for synchronous OData request messages. </summary> </member> <member name="P:Microsoft.OData.IODataRequestMessage.Headers"> <summary>Gets an enumerable over all the headers for this message.</summary> <returns>An enumerable over all the headers for this message.</returns> </member> <member name="P:Microsoft.OData.IODataRequestMessage.Url"> <summary>Gets or sets the request URL for this request message.</summary> <returns>The request URL for this request message.</returns> </member> <member name="P:Microsoft.OData.IODataRequestMessage.Method"> <summary>Gets or sets the HTTP method used for this request message.</summary> <returns>The HTTP method used for this request message.</returns> </member> <member name="M:Microsoft.OData.IODataRequestMessage.GetHeader(System.String)"> <summary>Returns a value of an HTTP header.</summary> <returns>The value of the HTTP header, or null if no such header was present on the message.</returns> <param name="headerName">The name of the header to get.</param> </member> <member name="M:Microsoft.OData.IODataRequestMessage.SetHeader(System.String,System.String)"> <summary>Sets the value of an HTTP header.</summary> <param name="headerName">The name of the header to set.</param> <param name="headerValue">The value of the HTTP header or 'null' if the header should be removed.</param> </member> <member name="M:Microsoft.OData.IODataRequestMessage.GetStream"> <summary>Gets the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="T:Microsoft.OData.IODataRequestMessageAsync"> <summary> Interface for asynchronous OData request messages. </summary> </member> <member name="M:Microsoft.OData.IODataRequestMessageAsync.GetStreamAsync"> <summary>Asynchronously get the stream backing for this message.</summary> <returns>The stream for this message.</returns> </member> <member name="T:Microsoft.OData.IODataResourceTypeContext"> <summary> Interface used for substitutability, to answer basic questions regarding the type of the resource or resource set. Metadata may come from a user-provided model or from the SetSerializationInfo() method on a resource set or resource. The latter is considered the "no-model" case since only strings are provided, and there is no interconnectedness. The goal of this interface is to provide a way to query the metadata information available on a resource or resource set without needing to know where the metadata originated from. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.NavigationSourceName"> <summary> The navigation source name of the resource set or resource. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.NavigationSourceEntityTypeName"> <summary> The entity type name of the navigation source of the resource set or resource. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.NavigationSourceFullTypeName"> <summary> The full type name of the navigation source of the resource set or resource. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.NavigationSourceKind"> <summary> The kind of the navigation source of the resource set or resource. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.ExpectedResourceTypeName"> <summary> The expected entity type name of the resource. For example, in the request URI 'http://example.com/Service.svc/People/Namespace.VIP_Person', the expected entity type is Namespace.VIP_Person. (The entity set element type name in this example may be Person, and the actual entity type of a particular entity might be a type more derived than VIP_Person) </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.IsMediaLinkEntry"> <summary> true if the resource is an MLE, false otherwise. </summary> </member> <member name="P:Microsoft.OData.IODataResourceTypeContext.IsFromCollection"> <summary> The flag we use to identify if the current resource is from a navigation property with collection type or not. </summary> </member> <member name="T:Microsoft.OData.IODataResponseMessage"> <summary> Interface for synchronous OData response messages. </summary> </member> <member name="P:Microsoft.OData.IODataResponseMessage.Headers"> <summary>Gets an enumerable over all the headers for this message.</summary> <returns>An enumerable over all the headers for this message.</returns> </member> <member name="P:Microsoft.OData.IODataResponseMessage.StatusCode"> <summary>Gets or sets the result status code of the response message.</summary> <returns>The result status code of the response message.</returns> </member> <member name="M:Microsoft.OData.IODataResponseMessage.GetHeader(System.String)"> <summary>Returns a value of an HTTP header.</summary> <returns>The value of the HTTP header, or null if no such header was present on the message.</returns> <param name="headerName">The name of the header to get.</param> </member> <member name="M:Microsoft.OData.IODataResponseMessage.SetHeader(System.String,System.String)"> <summary>Sets the value of an HTTP header.</summary> <param name="headerName">The name of the header to set.</param> <param name="headerValue">The value of the HTTP header or 'null' if the header should be removed.</param> </member> <member name="M:Microsoft.OData.IODataResponseMessage.GetStream"> <summary>Gets the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="T:Microsoft.OData.IODataResponseMessageAsync"> <summary> Interface for asynchronous OData response messages. </summary> </member> <member name="M:Microsoft.OData.IODataResponseMessageAsync.GetStreamAsync"> <summary>Asynchronously get the stream backing for this message.</summary> <returns>The stream backing for this message.</returns> </member> <member name="T:Microsoft.OData.IODataStreamListener"> <summary> An interface that allows creators of a stream to listen for status changes of the operation stream. </summary> </member> <member name="M:Microsoft.OData.IODataStreamListener.StreamRequested"> <summary> This method notifies the implementer of this interface that the content stream for a batch operation has been requested. </summary> </member> <member name="M:Microsoft.OData.IODataStreamListener.StreamRequestedAsync"> <summary> This method notifies the implementer of this interface that the content stream for a batch operation has been requested. </summary> <returns> A task representing any async operation that is running in reaction to the status change (or null if no such action is required). </returns> </member> <member name="M:Microsoft.OData.IODataStreamListener.StreamDisposed"> <summary> This method notifies the implementer of this interface that the content stream of a batch operation has been disposed. </summary> </member> <member name="M:Microsoft.OData.IODataStreamListener.StreamDisposedAsync"> <summary> Asynchronously notifies the implementer of this interface that the content stream of an operation has been disposed. </summary> <returns>A task that represents the asynchronous operation.</returns> </member> <member name="T:Microsoft.OData.IPrimitiveTypeConverter"> <summary> Interface used for serialization and deserialization of primitive types. </summary> </member> <member name="M:Microsoft.OData.IPrimitiveTypeConverter.WriteAtom(System.Object,System.Xml.XmlWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an XmlWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The Xml writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.IPrimitiveTypeConverter.WriteAtom(System.Object,System.IO.TextWriter)"> <summary> Write the Atom representation of an instance of a primitive type to an TextWriter. </summary> <param name="instance">The instance to write.</param> <param name="writer">The text writer to use to write the instance.</param> </member> <member name="M:Microsoft.OData.IPrimitiveTypeConverter.WriteJsonLight(System.Object,Microsoft.OData.Json.IJsonWriter)"> <summary> Write the Json Lite representation of an instance of a primitive type to a json writer. </summary> <param name="instance">The instance to write.</param> <param name="jsonWriter">Instance of JsonWriter.</param> </member> <member name="T:Microsoft.OData.IReaderValidator"> <summary> Reader validator interface. </summary> </member> <member name="M:Microsoft.OData.IReaderValidator.ValidateMediaResource(Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmEntityType)"> <summary> Validates that the specified <paramref name="resource"/> is a valid resource as per the specified type. </summary> <param name="resource">The resource to validate.</param> <param name="resourceType">Optional entity type to validate the resource against.</param> <remarks>If the <paramref name="resourceType"/> is available only resource-level tests are performed, properties and such are not validated.</remarks> </member> <member name="M:Microsoft.OData.IReaderValidator.CreatePropertyAndAnnotationCollector"> <summary> Creates a PropertyAndAnnotationCollector instance. </summary> <returns>The created instance.</returns> </member> <member name="M:Microsoft.OData.IReaderValidator.ValidateNullValue(Microsoft.OData.Edm.IEdmTypeReference,System.Boolean,System.String,System.Nullable{System.Boolean})"> <summary> Validate a null value. </summary> <param name="expectedTypeReference">The expected type of the null value.</param> <param name="validateNullValue">true to validate the null value; false to only check whether the type is supported.</param> <param name="propertyName">The name of the property whose value is being read, if applicable (used for error reporting).</param> <param name="isDynamicProperty">Indicates whether the property is dynamic or unknown.</param> </member> <member name="M:Microsoft.OData.IReaderValidator.ResolvePayloadTypeNameAndComputeTargetType(Microsoft.OData.Edm.EdmTypeKind,System.Nullable{System.Boolean},Microsoft.OData.Edm.IEdmType,Microsoft.OData.Edm.IEdmTypeReference,System.String,Microsoft.OData.Edm.IEdmModel,System.Func{Microsoft.OData.Edm.EdmTypeKind},Microsoft.OData.Edm.EdmTypeKind@,Microsoft.OData.ODataTypeAnnotation@)"> <summary> Resolves and validates the payload type against the expected type and returns the target type. </summary> <param name="expectedTypeKind">The expected type kind for the value.</param> <param name="expectStructuredType">This value indicates if a structured type is expected to be return. True for structured type, false for non-structured type, null for indetermination.</param> <param name="defaultPrimitivePayloadType">The default payload type if none is specified in the payload; for ATOM this is Edm.String, for JSON it is null since there is no payload type name for primitive types in the payload.</param> <param name="expectedTypeReference">The expected type reference, or null if no expected type is available.</param> <param name="payloadTypeName">The payload type name, or null if no payload type was specified.</param> <param name="model">The model to use.</param> <param name="typeKindFromPayloadFunc">A func to compute the type kind from the payload shape if it could not be determined from the expected type or the payload type.</param> <param name="targetTypeKind">The target type kind to be used to read the payload.</param> <param name="typeAnnotation">Potentially non-null instance of an annotation to put on the value reported from the reader.</param> <returns> The target type reference to use for parsing the value. If there is no user specified model, this will return null. If there is a user specified model, this method never returns null. </returns> <remarks> This method cannot be used for primitive type resolution. Primitive type resolution is format dependent and format specific methods should be used instead. </remarks> </member> <member name="M:Microsoft.OData.IReaderValidator.ValidatePropertyDefined(System.String,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Validates that a property with the specified name exists on a given structured type. The structured type can be null if no metadata is available. </summary> <param name="propertyName">The name of the property to validate.</param> <param name="owningStructuredType">The owning type of the property with name <paramref name="propertyName"/> or null if no metadata is available.</param> <returns>The <see cref="T:Microsoft.OData.Edm.IEdmProperty"/> instance representing the property with name <paramref name="propertyName"/> or null if no metadata is available.</returns> </member> <member name="M:Microsoft.OData.IReaderValidator.ValidateStreamReferenceProperty(Microsoft.OData.IODataStreamReferenceInfo,System.String,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.Edm.IEdmProperty)"> <summary> Validates a stream reference property. </summary> <param name="streamInfo">The stream property to check.</param> <param name="propertyName">The name of the property being validated.</param> <param name="structuredType">The owning type of the stream property or null if no metadata is available.</param> <param name="streamEdmProperty">The stream property defined by the model.</param> </member> <member name="T:Microsoft.OData.IWriterValidator"> <summary> Writer validator interface. </summary> </member> <member name="M:Microsoft.OData.IWriterValidator.GetDuplicatePropertyNameChecker"> <summary> Get a DuplicatePropertyNameChecker instance from the object pool. </summary> <returns>The instance retrieved from the object pool.</returns> </member> <member name="M:Microsoft.OData.IWriterValidator.ReturnDuplicatePropertyNameChecker(Microsoft.OData.IDuplicatePropertyNameChecker)"> <summary> Return a DuplicatePropertyNameChecker instance to the object pool. </summary> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateResourceInNestedResourceInfo(Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Validates a resource in an expanded link to make sure that the types match. </summary> <param name="resourceType">The <see cref="T:Microsoft.OData.Edm.IEdmStructuredType"/> of the resource.</param> <param name="parentNavigationPropertyType">The type of the parent navigation property or complex property or complex collection property.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateNestedResourceInfoHasCardinality(Microsoft.OData.ODataNestedResourceInfo)"> <summary> Validates that the specified nested resource info has cardinality set, i.e., it has the IsCollection value set. </summary> <param name="nestedResourceInfo">The nested resource info to validate.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateIsExpectedPrimitiveType(System.Object,Microsoft.OData.Edm.IEdmPrimitiveTypeReference,Microsoft.OData.Edm.IEdmTypeReference)"> <summary> Validates that a given primitive value is of the expected (primitive) type. </summary> <param name="value">The value to check.</param> <param name="valuePrimitiveTypeReference">The primitive type reference for the value. So some callers have this already, and we save the lookup here.</param> <param name="expectedTypeReference">The expected type for the value.</param> <remarks> Some callers have the primitive type reference already resolved (from the value type), and the method will not lookup the primitive type reference again. </remarks> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateTypeReference(Microsoft.OData.Edm.IEdmTypeReference,Microsoft.OData.Edm.IEdmTypeReference)"> <summary> Validates the value type reference against metadata. </summary> <param name="typeReferenceFromMetadata">The metadata type reference.</param> <param name="typeReferenceFromValue">The value type reference.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateTypeKind(Microsoft.OData.Edm.EdmTypeKind,Microsoft.OData.Edm.EdmTypeKind,System.Nullable{System.Boolean},Microsoft.OData.Edm.IEdmType)"> <summary> Validates that the observed type kind is the expected type kind. </summary> <param name="actualTypeKind">The actual type kind.</param> <param name="expectedTypeKind">The expected type kind.</param> <param name="expectStructuredType">This value indicates if the <paramref name="actualTypeKind"/> is expected to be complex or entity. True for complex or entity, false for non-structured type kind, null for indetermination.</param> <param name="edmType">The edm type to use in the error.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateMetadataResource(Microsoft.OData.ODataResourceBase,Microsoft.OData.Edm.IEdmEntityType)"> <summary> Validates that the specified <paramref name="resource"/> is a valid resource as per the specified type. </summary> <param name="resource">The resource to validate.</param> <param name="resourceType">Optional entity type to validate the resource against.</param> <remarks> If the <paramref name="resourceType"/> is available, only resource-level tests are performed; properties and such are not validated. </remarks> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateNullPropertyValue(Microsoft.OData.Edm.IEdmTypeReference,System.String,System.Boolean,Microsoft.OData.Edm.IEdmModel)"> <summary> Validates that the expected property allows null value. </summary> <param name="expectedPropertyTypeReference">The expected property type or null if we don't have any.</param> <param name="propertyName">The name of the property.</param> <param name="isTopLevel">true if the property is top-level.</param> <param name="model">The model used to get the OData version.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateNullCollectionItem(Microsoft.OData.Edm.IEdmTypeReference)"> <summary> Validates a null collection item against the expected type. </summary> <param name="expectedItemType">The expected item type or null if none.</param> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidatePropertyDefined(System.String,Microsoft.OData.Edm.IEdmStructuredType)"> <summary> Validates that a property with the specified name exists on a given structured type. The structured type can be null if no metadata is available. </summary> <param name="propertyName">Name of the property.</param> <param name="owningStructuredType">Hosting type of the property or null if no metadata is available.</param> <returns>An <see cref="T:Microsoft.OData.Edm.IEdmProperty"/> instance representing the specified property or null if no metadata is available.</returns> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateNestedResourceInfo(Microsoft.OData.ODataNestedResourceInfo,Microsoft.OData.Edm.IEdmStructuredType,System.Nullable{Microsoft.OData.ODataPayloadKind})"> <summary> Validates an <see cref="T:Microsoft.OData.ODataNestedResourceInfo"/> to ensure all required information is specified and valid. </summary> <param name="nestedResourceInfo">The nested resource info to validate.</param> <param name="declaringStructuredType">The <see cref="T:Microsoft.OData.Edm.IEdmStructuredType"/> declaring the structural property or navigation property; or null if metadata is not available.</param> <param name="expandedPayloadKind">The <see cref="T:Microsoft.OData.ODataPayloadKind"/> of the expanded content of this nested resource info or null for deferred links.</param> <returns>The type of the navigation property for this nested resource info; or null if no <paramref name="declaringStructuredType"/> was specified.</returns> </member> <member name="M:Microsoft.OData.IWriterValidator.ValidateDerivedTypeConstraint(Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.Edm.IEdmStructuredType,System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> Validates the input <see cref="T:Microsoft.OData.Edm.IEdmStructuredType"/> meets the derived type constraints on the <see cref="T:Microsoft.OData.Edm.IEdmNavigationSource"/>. </summary> <param name="resourceType">The input resource type.</param> <param name="metadataType">The type from metadata.</param> <param name="derivedTypeConstraints">The derived type constraints on the nested resource.</param> <param name="itemKind">The item kind.</param> <param name="itemName">The item name.</param> </member> <member name="T:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState"> <summary> Interface representing a state of the JSON reader for resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.Resource"> <summary> The resource being read. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.ResourceType"> <summary> The structured type for the resource (if available) </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.ResourceTypeFromMetadata"> <summary> The expected type defined in the model for the resource (if available) </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.NavigationSource"> <summary> The navigation source for the resource (if available) </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.MetadataBuilder"> <summary> The metadata builder instance for the resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.AnyPropertyFound"> <summary> Flag which indicates that during parsing of the resource represented by this state, any property which is not an instance annotation was found. This includes property annotations for property which is not present in the payload. </summary> <remarks> This is used to detect incorrect ordering of the payload (for example odata.id must not come after the first property). </remarks> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.FirstNestedInfo"> <summary> If the reader finds a nested resource info to report, but it must first report the parent resource it will store the nested resource info in this property. So this will only ever store the first nested resource info of a resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.PropertyAndAnnotationCollector"> <summary> The duplicate property names checker for the resource represented by the current state. May be null. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.SelectedProperties"> <summary> The selected properties that should be expanded during template evaluation. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.NavigationPropertiesRead"> <summary> The set of names of the navigation properties we have read so far while reading the resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightReaderResourceState.ProcessingMissingProjectedNestedResourceInfos"> <summary> true if we have started processing missing projected navigation links, false otherwise. </summary> </member> <member name="T:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState"> <summary> Interface representing a state of the JSON writer for resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.Resource"> <summary> The resource being written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.ResourceType"> <summary> The structured type for the resource (if available) </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.ResourceTypeFromMetadata"> <summary> The structured type which was derived from the model (may be either the same as structured type or its base type). </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.SerializationInfo"> <summary> The serialization info for the current resource. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.IsUndeclared"> <summary> The current resource is for undeclared property or not. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.EditLinkWritten"> <summary> Flag which indicates that the odata.editLink metadata property has been written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.ReadLinkWritten"> <summary> Flag which indicates that the odata.readLink metadata property has been written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.MediaEditLinkWritten"> <summary> Flag which indicates that the odata.mediaEditLink metadata property has been written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.MediaReadLinkWritten"> <summary> Flag which indicates that the odata.mediaReadLink metadata property has been written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.MediaContentTypeWritten"> <summary> Flag which indicates that the odata.mediaContentType metadata property has been written. </summary> </member> <member name="P:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.MediaETagWritten"> <summary> Flag which indicates that the odata.mediaEtag metadata property has been written. </summary> </member> <member name="M:Microsoft.OData.JsonLight.IODataJsonLightWriterResourceState.GetOrCreateTypeContext(System.Boolean)"> <summary> Gets or creates the type context to answer basic questions regarding the type info of the resource. </summary> <param name="writingResponse">True if writing a response payload, false otherwise.</param> <returns>The type context to answer basic questions regarding the type info of the resource.</returns> </member> <member name="T:Microsoft.OData.JsonLight.JsonFullMetadataLevel"> <summary> Class responsible for logic specific to the JSON Light full metadata level (indicated by "odata.metadata=full" in the media type). </summary> <remarks> The general rule-of-thumb for full-metadata payloads is that they include all "odata.*" annotations that would be included in minimal metadata mode, plus any "odata.*" annotations that could be computed client-side if we the client had a model. </remarks> </member> <member name="F:Microsoft.OData.JsonLight.JsonFullMetadataLevel.model"> <summary> The Edm model. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonFullMetadataLevel.metadataDocumentUri"> <summary> The metadata document uri from the writer settings. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataLevel.#ctor(System.Uri,Microsoft.OData.Edm.IEdmModel)"> <summary> Constructs a new <see cref="T:Microsoft.OData.JsonLight.JsonFullMetadataLevel"/>. </summary> <param name="metadataDocumentUri">The metadata document uri from the writer settings.</param> <param name="model">The Edm model.</param> </member> <member name="P:Microsoft.OData.JsonLight.JsonFullMetadataLevel.NonNullMetadataDocumentUri"> <summary> Returns the metadata document URI which has been validated to be non-null. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataLevel.GetTypeNameOracle"> <summary> Returns the oracle to use when determining the type name to write for entries and values. </summary> <returns>An oracle that can be queried to determine the type name to write.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataLevel.CreateResourceMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.SelectedPropertiesNode,System.Boolean,System.Boolean,System.Nullable{Microsoft.OData.ODataUriSlim}@,Microsoft.OData.ODataMessageWriterSettings)"> <summary> Creates the metadata builder for the given resource. If such a builder is set, asking for payload metadata properties (like EditLink) of the resource may return a value computed by convention, depending on the metadata level and whether the user manually set an edit link or not. </summary> <param name="resource">The resource to create the metadata builder for.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource or resource set.</param> <param name="serializationInfo">The serialization info for the resource.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="selectedProperties">The selected properties of this scope.</param> <param name="isResponse">true if the resource metadata builder to create should be for a response payload; false for a request.</param> <param name="keyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses.</param> <param name="odataUri">The OData Uri.</param> <param name="settings">OData message writer settings.</param> <returns>The created metadata builder.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataLevel.InjectMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.Evaluation.ODataResourceMetadataBuilder)"> <summary> Injects the appropriate metadata builder based on the metadata level. </summary> <param name="resource">The resource to inject the builder.</param> <param name="builder">The metadata builder to inject.</param> </member> <member name="T:Microsoft.OData.JsonLight.JsonFullMetadataTypeNameOracle"> <summary> Class responsible for determining the type name that should be written on the wire for entries and values in JSON full metadata mode. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataTypeNameOracle.GetResourceSetTypeNameForWriting(System.String,Microsoft.OData.ODataResourceSet,System.Boolean)"> <summary> Determines the resource set type name to write to the payload. </summary> <param name="expectedResourceTypeName">The expected resource type name of the items in the resource set.</param> <param name="resourceSet">The ODataResourceSet whose type is to be written.</param> <param name="isUndeclared">true if the resource set is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataTypeNameOracle.GetResourceTypeNameForWriting(System.String,Microsoft.OData.ODataResourceBase,System.Boolean)"> <summary> Determines the resource type name to write to the payload. </summary> <param name="expectedTypeName">The expected type name, e.g. the base type of the an entity set or a collection of complex or the nav prop or a complex property.</param> <param name="resource">The ODataResource whose type is to be written.</param> <param name="isUndeclared">true if the ODataResource is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.Edm.IEdmTypeReference,Microsoft.OData.Edm.IEdmTypeReference,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="typeReferenceFromMetadata">The type as expected by the model.</param> <param name="typeReferenceFromValue">The type resolved from the value.</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonFullMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.PropertySerializationInfo,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="propertyInfo">The serialization info of current property</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="T:Microsoft.OData.JsonLight.JsonLightConstants"> <summary> Constants for the JSON Lite format. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataAnnotationNamespacePrefix"> <summary>The prefix for OData annotation names.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataPropertyAnnotationSeparatorChar"> <summary>The separator of property annotations.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataNullPropertyName"> <summary> The 'null' property name for the Json Light value property. This is an OData 3.0 protocol element used for compatibility with 6.x library version. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataNullAnnotationTrueValue"> <summary>The value 'true' for the OData null annotation.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataValuePropertyName"> <summary>The 'value' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataErrorPropertyName"> <summary>The 'error' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataSourcePropertyName"> <summary>The 'source' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataTargetPropertyName"> <summary>The 'target' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataRelationshipPropertyName"> <summary>The 'relationship' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataIdPropertyName"> <summary>The 'id' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataDeltaPropertyName"> <summary>The 'delta' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataReasonPropertyName"> <summary>The 'reason' property name for the Json Light value property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataReasonChangedValue"> <summary>The value 'changed' for the Json Light 'reason' property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataReasonDeletedValue"> <summary>The value 'deleted' for the Json Light 'reason' property.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataServiceDocumentElementUrlName"> <summary>The name of the property returned for a URL of a service document element.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataServiceDocumentElementTitle"> <summary>The string used for the title attribute for the service document element.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataServiceDocumentElementKind"> <summary>The string used for the kind attribute for the service document element.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ODataServiceDocumentElementName"> <summary>The name of the property returned for a name of a service document element.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ContextUriSelectQueryOptionName"> <summary>The name of the $select query option.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ContextUriQueryOptionValueSeparator"> <summary>The '=' character used to separate a query option name from its value.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ContextUriQueryOptionSeparator"> <summary>The '&' separator character between query options.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.FunctionParameterStart"> <summary>The '(' used to mark the start of function parameters in the fragment of a context URI.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.FunctionParameterEnd"> <summary>The ')' used to mark the end of function parameters in the fragment of a context URI.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.FunctionParameterSeparator"> <summary>The "," to use as the separator for the function parameters in the fragment of a context URI.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.FunctionParameterSeparatorChar"> <summary>The ',' to use as the separator for the function parameters.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.FunctionParameterAssignment"> <summary> The "=@" to use as the separator for the function parameter in target.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ServiceDocumentSingletonKindName"> <summary> The kind name of the service document singleton element. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ServiceDocumentFunctionImportKindName"> <summary> The kind name of the service document function import element. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.ServiceDocumentEntitySetKindName"> <summary> The kind name of the service document entity set element. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.SimplifiedODataContextPropertyName"> <summary>The simplified OData Context property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.SimplifiedODataIdPropertyName"> <summary>The simplified OData Id property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.SimplifiedODataTypePropertyName"> <summary>The simplified OData Type property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.SimplifiedODataRemovedPropertyName"> <summary>The simplified Removed property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.PrefixedODataContextPropertyName"> <summary>The prefixed OData Context property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.PrefixedODataTypePropertyName"> <summary>The prefixed OData Type property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.PrefixedODataIdPropertyName"> <summary>The prefixed OData Id property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.PrefixedODataNullPropertyName"> <summary>The prefixed OData Null property name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightConstants.PrefixedODataRemovedPropertyName"> <summary>The prefixed OData Removed property name.</summary> </member> <member name="T:Microsoft.OData.JsonLight.JsonLightMetadataLevel"> <summary> Class responsible for logic that varies based on the JSON Light metadata level. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightMetadataLevel.Create(Microsoft.OData.ODataMediaType,System.Uri,Microsoft.OData.Edm.IEdmModel,System.Boolean)"> <summary> Creates the appropriate metadata level based on the media type being written. </summary> <param name="mediaType">The full media type being written. This media type must have a type/subtype of "application/json".</param> <param name="metadataDocumentUri">The metadata document uri from the writer settings.</param> <param name="model">The edm model.</param> <param name="writingResponse">true if we are writing a response, false otherwise.</param> <returns>The JSON Light metadata level being written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightMetadataLevel.Create(Microsoft.OData.ODataMediaType,System.Uri,System.Boolean,Microsoft.OData.Edm.IEdmModel,System.Boolean)"> <summary> Creates the appropriate metadata level based on the media type being written. </summary> <param name="mediaType">The full media type being written. This media type must have a type/subtype of "application/json".</param> <param name="metadataDocumentUri">The metadata document uri from the writer settings.</param> <param name="alwaysAddTypeAnnotationsForDerivedTypes">When set, type annotations will be added for derived types, even when the metadata level is set to "None".</param> <param name="model">The edm model.</param> <param name="writingResponse">true if we are writing a response, false otherwise.</param> <returns>The JSON Light metadata level being written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightMetadataLevel.GetTypeNameOracle"> <summary> Returns the oracle to use when determining the type name to write for entries and values. </summary> <returns>An oracle that can be queried to determine the type name to write.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightMetadataLevel.CreateResourceMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.SelectedPropertiesNode,System.Boolean,System.Boolean,System.Nullable{Microsoft.OData.ODataUriSlim}@,Microsoft.OData.ODataMessageWriterSettings)"> <summary> Creates the metadata builder for the given resource. If such a builder is set, asking for payload metadata properties (like EditLink) of the resource may return a value computed by convention, depending on the metadata level and whether the user manually set an edit link or not. </summary> <param name="resource">The resource to create the metadata builder for.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource or resource set.</param> <param name="serializationInfo">The serialization info for the resource.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="selectedProperties">The selected properties of this scope.</param> <param name="isResponse">true if the resource metadata builder to create should be for a response payload; false for a request.</param> <param name="keyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses. A null value means the user hasn't specified a preference and we should look for an annotation in the entity container, if available.</param> <param name="odataUri">The OData Uri.</param> <param name="settings">The settings to use when creating the resource builder.</param> <returns>The created metadata builder.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightMetadataLevel.InjectMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.Evaluation.ODataResourceMetadataBuilder)"> <summary> Injects the appropriate metadata builder based on the metadata level. </summary> <param name="resource">The resource to inject the builder.</param> <param name="builder">The metadata builder to inject.</param> </member> <member name="T:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter"> <summary> JsonLight writer for OData annotations, i.e., odata.* </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.ODataAnnotationPrefixLength"> <summary> Length of "odata.". </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.jsonWriter"> <summary> The underlying JSON writer. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.asyncJsonWriter"> <summary> The underlying asynchronous JSON writer. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.enableWritingODataAnnotationWithoutPrefix"> <summary> Whether write odata annotation without "odata." prefix in name. </summary> </member> <member name="F:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.odataVersion"> <summary> OData Version to use when writing OData annotations. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.#ctor(Microsoft.OData.Json.IJsonWriter,System.Boolean,System.Nullable{Microsoft.OData.ODataVersion})"> <summary> Constructor. </summary> <param name="jsonWriter">The underlying JSON writer.</param> <param name="enableWritingODataAnnotationWithoutPrefix">Whether write odata annotation without "odata." prefix in name.</param> <param name="odataVersion">OData Version used when writing the annotations.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.#ctor(Microsoft.OData.Json.IJsonWriterAsync,System.Boolean,System.Nullable{Microsoft.OData.ODataVersion})"> <summary> Constructor. </summary> <param name="jsonWriter">The underlying JSON writer.</param> <param name="enableWritingODataAnnotationWithoutPrefix">Whether write odata annotation without "odata." prefix in name.</param> <param name="odataVersion">OData Version used when writing the annotations.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteODataTypeInstanceAnnotation(System.String,System.Boolean)"> <summary> Writes the odata.type instance annotation with the specified type name. </summary> <param name="typeName">The type name to write.</param> <param name="writeRawValue">Whether to write the raw typeName without removing/adding prefix 'Edm.'/'#'.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteODataTypePropertyAnnotation(System.String,System.String)"> <summary> Writes the odata.type property annotation for the specified property with the specified type name. </summary> <param name="propertyName">The name of the property for which to write the odata.type annotation.</param> <param name="typeName">The type name to write.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WritePropertyAnnotationName(System.String,System.String)"> <summary> Write a JSON property name which represents a property annotation. </summary> <param name="propertyName">The name of the property to annotate.</param> <param name="annotationName">The name of the annotation to write.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteInstanceAnnotationName(System.String)"> <summary> Write a JSON instance annotation name which represents a instance annotation. </summary> <param name="annotationName">The name of the instance annotation to write.</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteODataTypeInstanceAnnotationAsync(System.String,System.Boolean)"> <summary> Asynchronously writes the odata.type instance annotation with the specified type name. </summary> <param name="typeName">The type name to write.</param> <param name="writeRawValue">Whether to write the raw typeName without removing/adding prefix 'Edm.'/'#'.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteODataTypePropertyAnnotationAsync(System.String,System.String)"> <summary> Asynchronously writes the odata.type property annotation for the specified property with the specified type name. </summary> <param name="propertyName">The name of the property for which to write the odata.type annotation.</param> <param name="typeName">The type name to write.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WritePropertyAnnotationNameAsync(System.String,System.String)"> <summary> Asynchronously writes a JSON property name which represents a property annotation. </summary> <param name="propertyName">The name of the property to annotate.</param> <param name="annotationName">The name of the annotation to write.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.WriteInstanceAnnotationNameAsync(System.String)"> <summary> Asynchronously writes a JSON instance annotation name which represents a instance annotation. </summary> <param name="annotationName">The name of the instance annotation to write.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.SimplifyODataAnnotationName(System.String)"> <summary> Simplify OData annotation name if necessary. </summary> <param name="annotationName">The annotation name to be simplified.</param> <returns>The simplified annotation name.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.AssertSynchronous"> <summary> Asserts that the annotation writer was created for asynchronous operation. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightODataAnnotationWriter.AssertAsynchronous"> <summary> Asserts that the annotation writer was created for asynchronous operation. </summary> </member> <member name="T:Microsoft.OData.JsonLight.JsonLightTypeNameOracle"> <summary> Class responsible for determining the type name that should be written on the wire for entries and values in JSON Light. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightTypeNameOracle.GetResourceSetTypeNameForWriting(System.String,Microsoft.OData.ODataResourceSet,System.Boolean)"> <summary> Determines the resource set type name to write to the payload. </summary> <param name="expectedResourceTypeName">The expected resource type name of the items in the resource set.</param> <param name="resourceSet">The ODataResourceSet whose type is to be written.</param> <param name="isUndeclared">true if the resource set is for some undeclared property.</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightTypeNameOracle.GetResourceTypeNameForWriting(System.String,Microsoft.OData.ODataResourceBase,System.Boolean)"> <summary> Determines the entity type name to write to the payload. </summary> <param name="expectedTypeName">The expected type name, e.g. the base type of the set or the nav prop.</param> <param name="resource">The ODataResource whose type is to be written.</param> <param name="isUndeclared">true if the resource is for some undeclared property.</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.Edm.IEdmTypeReference,Microsoft.OData.Edm.IEdmTypeReference,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="typeReferenceFromMetadata">The type as expected by the model.</param> <param name="typeReferenceFromValue">The type resolved from the value.</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonLightTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.PropertySerializationInfo,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="propertyInfo">The serialization info of current property</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="T:Microsoft.OData.JsonLight.JsonMinimalMetadataLevel"> <summary> Class responsible for logic specific to the JSON Light minimal metadata level (indicated by "odata.metadata=minimal" in the media type, or lack of an "odata" parameter in a v3 and above request). </summary> <remarks> The general rule-of-thumb for minimal-metadata payloads is that they include all "odata.*" annotations that can't be computed client-side, assuming the client has the server model available as well as the ability to compute missing payload metadata based on the standard conventions. </remarks> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataLevel.GetTypeNameOracle"> <summary> Returns the oracle to use when determining the type name to write for entries and values. </summary> <returns>An oracle that can be queried to determine the type name to write.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataLevel.CreateResourceMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.SelectedPropertiesNode,System.Boolean,System.Boolean,System.Nullable{Microsoft.OData.ODataUriSlim}@,Microsoft.OData.ODataMessageWriterSettings)"> <summary> Creates the metadata builder for the given resource. If such a builder is set, asking for payload metadata properties (like EditLink) of the resource may return a value computed by convention, depending on the metadata level and whether the user manually set an edit link or not. </summary> <param name="resource">The resource to create the metadata builder for.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource or resource set.</param> <param name="serializationInfo">The serialization info for the resource.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="selectedProperties">The selected properties of this scope.</param> <param name="isResponse">true if the resource metadata builder to create should be for a response payload; false for a request.</param> <param name="keyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses.</param> <param name="odataUri">The OData Uri.</param> <param name="settings">The settings to use when creating the resource builder.</param> <returns>The created metadata builder.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataLevel.InjectMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.Evaluation.ODataResourceMetadataBuilder)"> <summary> Injects the appropriate metadata builder based on the metadata level. </summary> <param name="resource">The resource to inject the builder.</param> <param name="builder">The metadata builder to inject.</param> </member> <member name="T:Microsoft.OData.JsonLight.JsonMinimalMetadataTypeNameOracle"> <summary> Class responsible for determining the type name that should be written on the wire for entries and values in JSON minimal metadata mode, </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataTypeNameOracle.GetResourceSetTypeNameForWriting(System.String,Microsoft.OData.ODataResourceSet,System.Boolean)"> <summary> Determines the resource set type name to write to the payload. </summary> <param name="expectedResourceTypeName">The expected resource type name of the items in the resource set.</param> <param name="resourceSet">The ODataResourceSet whose type is to be written.</param> <param name="isUndeclared">true if the resource set is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataTypeNameOracle.GetResourceTypeNameForWriting(System.String,Microsoft.OData.ODataResourceBase,System.Boolean)"> <summary> Determines the entity type name to write to the payload. </summary> <param name="expectedTypeName">The expected type name, e.g. the base type of the set or the nav prop.</param> <param name="resource">The ODataResource whose type is to be written.</param> <param name="isUndeclared">true if the ODataResource is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.Edm.IEdmTypeReference,Microsoft.OData.Edm.IEdmTypeReference,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="typeReferenceFromMetadata">The type as expected by the model.</param> <param name="typeReferenceFromValue">The type resolved from the value.</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonMinimalMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.PropertySerializationInfo,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="propertyInfo">The serialization info of current property</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="T:Microsoft.OData.JsonLight.JsonNoMetadataLevel"> <summary> Class responsible for logic specific to the JSON Light no metadata level (indicated by "odata.metadata=none" in the media type). </summary> <remarks> The general rule-of-thumb for no-metadata payloads is that they omit any "odata.*" annotations, except for odata.nextlink and odata.count, since the client would get a inaccurate representation of the data available if they were left out. </remarks> </member> <member name="F:Microsoft.OData.JsonLight.JsonNoMetadataLevel.alwaysAddTypeAnnotationsForDerivedTypes"> <summary> When set, type annotations will be added for derived types, even when the metadata level is set to "None". </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataLevel.#ctor"> <summary> Constructs a new <see cref="T:Microsoft.OData.JsonLight.JsonNoMetadataLevel"/>. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataLevel.#ctor(System.Boolean)"> <summary> Constructs a new <see cref="T:Microsoft.OData.JsonLight.JsonNoMetadataLevel"/>. </summary> <param name="alwaysAddTypeAnnotationsForDerivedTypes">When set, type annotations will be added for derived types, even when the metadata level is set to "None".</param> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataLevel.GetTypeNameOracle"> <summary> Returns the oracle to use when determining the type name to write for entries and values. </summary> <returns>An oracle that can be queried to determine the type name to write.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataLevel.CreateResourceMetadataBuilder(Microsoft.OData.ODataResourceBase,Microsoft.OData.IODataResourceTypeContext,Microsoft.OData.ODataResourceSerializationInfo,Microsoft.OData.Edm.IEdmStructuredType,Microsoft.OData.SelectedPropertiesNode,System.Boolean,System.Boolean,System.Nullable{Microsoft.OData.ODataUriSlim}@,Microsoft.OData.ODataMessageWriterSettings)"> <summary> Creates the metadata builder for the given resource. If such a builder is set, asking for payload metadata properties (like EditLink) of the resource may return a value computed by convention, depending on the metadata level and whether the user manually set an edit link or not. </summary> <param name="resource">The resource to create the metadata builder for.</param> <param name="typeContext">The context object to answer basic questions regarding the type of the resource or resource set.</param> <param name="serializationInfo">The serialization info for the resource.</param> <param name="actualResourceType">The structured type of the resource.</param> <param name="selectedProperties">The selected properties of this scope.</param> <param name="isResponse">true if the resource metadata builder to create should be for a response payload; false for a request.</param> <param name="keyAsSegment">true if keys should go in separate segments in auto-generated URIs, false if they should go in parentheses.</param> <param name="odataUri">The OData Uri.</param> <param name="settings">The settings to use when creating the resource builder.</param> <returns>The created metadata builder.</returns> </member> <member name="T:Microsoft.OData.JsonLight.JsonNoMetadataTypeNameOracle"> <summary> Class responsible for determining the type name that should be written on the wire for entries and values in JSON no metadata mode. </summary> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataTypeNameOracle.GetResourceSetTypeNameForWriting(System.String,Microsoft.OData.ODataResourceSet,System.Boolean)"> <summary> Determines the resource set type name to write to the payload. </summary> <param name="expectedResourceTypeName">The expected resource type name of the items in the resource set.</param> <param name="resourceSet">The ODataResourceSet whose type is to be written.</param> <param name="isUndeclared">true if the resource set is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataTypeNameOracle.GetResourceTypeNameForWriting(System.String,Microsoft.OData.ODataResourceBase,System.Boolean)"> <summary> Determines the entity type name to write to the payload. </summary> <param name="expectedTypeName">The expected type name, e.g. the base type of the set or the nav prop.</param> <param name="resource">The ODataResource whose type is to be written.</param> <param name="isUndeclared">true if the ODataResource is for some undeclared property</param> <returns>Type name to write to the payload, or null if no type name should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.Edm.IEdmTypeReference,Microsoft.OData.Edm.IEdmTypeReference,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="typeReferenceFromMetadata">The type as expected by the model.</param> <param name="typeReferenceFromValue">The type resolved from the value.</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="M:Microsoft.OData.JsonLight.JsonNoMetadataTypeNameOracle.GetValueTypeNameForWriting(Microsoft.OData.ODataValue,Microsoft.OData.PropertySerializationInfo,System.Boolean)"> <summary> Determines the type name to write to the payload. Json Light type names are only written into the payload for open properties or if the payload type name is more derived than the model type name. </summary> <param name="value">The ODataValue whose type name is to be written.</param> <param name="propertyInfo">The serialization info of current property</param> <param name="isOpenProperty">true if the type name belongs to an open property, false otherwise.</param> <returns>Type name to write to the payload, or null if no type should be written.</returns> </member> <member name="T:Microsoft.OData.JsonLight.ODataAnnotationNames"> <summary> Well known OData annotation names reserved for OData Lib. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.KnownODataAnnotationNames"> <summary> Hash set of known odata annotation names that have special meanings to OData Lib. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataContext"> <summary>The OData Context annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataType"> <summary>The OData Type annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataId"> <summary>The OData ID annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataETag"> <summary>The OData etag annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataEditLink"> <summary>The OData edit link annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataReadLink"> <summary>The OData read link annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataMediaEditLink"> <summary>The OData media edit link annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataMediaReadLink"> <summary>The OData media read link annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataMediaContentType"> <summary>The OData media content type annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataMediaETag"> <summary>The OData media etag annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataCount"> <summary>The 'odata.count' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataNextLink"> <summary>The 'odata.nextLink' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataNavigationLinkUrl"> <summary>The 'odata.navigationLink' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataBind"> <summary>The 'odata.bind' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataAssociationLinkUrl"> <summary>The 'odata.associationLink' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataDeltaLink"> <summary>The 'odata.deltaLink' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataRemoved"> <summary>The 'odata.removed' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataDelta"> <summary>The 'odata.delta' annotation name.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataAnnotationNames.ODataNull"> <summary> The OData Null annotation name. This is an OData 3.0 protocol element used for compatibility with 6.x library version. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataAnnotationNames.IsODataAnnotationName(System.String)"> <summary> Returns true if the <paramref name="annotationName"/> starts with "odata.", false otherwise. </summary> <param name="annotationName">The name of the annotation in question.</param> <returns>Returns true if the <paramref name="annotationName"/> starts with "odata.", false otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataAnnotationNames.IsUnknownODataAnnotationName(System.String)"> <summary> Returns true if the <paramref name="annotationName"/> starts with "odata." and is not one of the reserved odata annotation names; returns false otherwise. </summary> <param name="annotationName">The annotation name in question.</param> <returns>Returns true if the <paramref name="annotationName"/> starts with "odata." and is not one of the reserved odata annotation names; returns false otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataAnnotationNames.ValidateIsCustomAnnotationName(System.String)"> <summary> Validates that the <paramref name="annotationName"/> is not a reserved OData instance annotation. </summary> <param name="annotationName">The instance annotation name to check.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataAnnotationNames.RemoveAnnotationPrefix(System.String)"> <summary> Get the string without the instance annotation prefix @ </summary> <param name="annotationName">the origin annotation name from reader</param> <returns>the annotation name without prefix @ </returns> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache"> <summary> Cache for atomic groups along with the stably-ordered message Ids in each group. It also keeps track of atomic group start and atomic group end status during the reading of batch message. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.groupToMessageIds"> <summary> Lookup table for atomicitGroup. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.precedingMessageGroupId"> <summary> Group Id of the preceding message. Could be null. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.isWithinAtomicGroup"> <summary> Latest status of whether the processing is within scope of an atomic group. The scope is ended by a top-level message, the starting of another atomic group, or end of the batch messages array. </summary> </member> <member name="P:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.IsWithinAtomicGroup"> <summary> Whether the processing is within scope of an atomic group. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.IsChangesetEnd(System.String)"> <summary> Given the group Id from reader's current state, determine whether atomic group end is detected. </summary> <param name="groupId">The group Id from the reader's current state.</param> <returns>True if atomic group end is detected; false otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.AddMessageIdAndGroupId(System.String,System.String)"> <summary> Construct the list of Ids for the group, and determine whether this is the start of an atomic group. </summary> <param name="messageId">Message Id to add.</param> <param name="groupId">Id of the group to add the message Id. Cannot be null.</param> <returns> True if changeset start is detected; false otherwise. Ensure all message Ids of the same groups are adjacent, otherwise throw an error. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.GetGroupId(System.String)"> <summary> Get the atomic group Id of the message; null if the message does not belong to any groups. </summary> <param name="targetMessageId">Id of the message from the json property.</param> <returns>The group Id if found; null otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.IsGroupId(System.String)"> <summary> Testing whether the given Id is a group Id. </summary> <param name="id">The id under test.</param> <returns>True if it is group Id of the batch; false otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchAtomicGroupCache.GetFlattenedMessageIds(System.Collections.Generic.IList{System.String})"> <summary> Flatten a given list of groupIds and messageIds into a string containing comma-separated message Ids. </summary> <param name="ids">List of ids to be flattened.</param> <returns>The list containing comma-separated message Ids.</returns> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream"> <summary> Wrapper stream backed by memory stream containing body content of request or response in Json batch. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.listener"> <summary>Listener interface to be notified of operation changes.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.cachedBodyContent"> <summary> Cached body content which needs to be processed later when we have information about the content-type value. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.#ctor(Microsoft.OData.IODataStreamListener)"> <summary> Constructor using default encoding (Base64Url without the BOM preamble). </summary> <param name="listener">The batch operation listener.</param> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.BatchPayloadBodyContentType"> <summary> Enum type for data type of body content. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.PopulateBodyContent(Microsoft.OData.Json.IJsonReader,System.String)"> <summary> Populates the body content the Json reader is referencing. Since the content-type header might not be available at this point (when "headers" attribute is read after the "body" attribute), if the content-type is not json the body content is first stored into a string which will be used to populate the stream when the content-type header is read later. </summary> <param name="jsonReader">The Json reader providing access to the data.</param> <param name="contentTypeHeader">The request's content-type header value.</param> <returns>True if body content is written to stream; false otherwise.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.PopulateCachedBodyContent(System.String)"> <summary> Populates the stream with the cached body content according to the content-type specified. </summary> <param name="contentTypeHeader">The content-type header value.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.PopulateBodyContentAsync(Microsoft.OData.Json.IJsonReaderAsync,System.String)"> <summary> Asynchronously populates the body content the Json reader is referencing. Since the content-type header might not be available at this point (when "headers" attribute is read after the "body" attribute), if the content-type is not json the body content is first stored into a string which will be used to populate the stream when the content-type header is read later. </summary> <param name="jsonReader">The Json reader providing access to the data.</param> <param name="contentTypeHeader">The request's content-type header value.</param> <returns> A task that represents the asynchronous write operation. The value of the TResult parameter contains true if body content is written to stream; false otherwise. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.PopulateCachedBodyContentAsync(System.String)"> <summary> Asynchronously populates the stream with the cached body content according to the content-type specified. </summary> <param name="contentTypeHeader">The content-type header value.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.Dispose(System.Boolean)"> <summary> Disposes the object. </summary> <param name="disposing">True if called from Dispose; false if called form the finalizer.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.DetectBatchPayloadBodyContentType(Microsoft.OData.Json.IJsonReader,System.String)"> <summary> Detects batch item (request or response) body content's data type. The content of the "body" property can be either Json type or binary type. </summary> <param name="jsonReader">The json reader that provides access to the json object.</param> <param name="contentTypeHeader">The request's content-type header value.</param> <returns>The detected batch operation payload type. Can be null if content-type header information is not yet available and json reader is reading primitive type.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.GetMediaType(System.String)"> <summary> Parses the content-type header to get the media type without parameters. </summary> <param name="contentTypeHeader">The content-type header value.</param> <returns>The media type object without parameters, or null if value is null or empty.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteJsonContent(Microsoft.OData.Json.IJsonReader)"> <summary> Reads off the data of the starting Json object from the Json reader, and populate the data into the memory stream. </summary> <param name="reader"> The json reader pointing at the json structure whose data needs to be populated into an memory stream. </param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteBinaryContent(System.String)"> <summary> Decodes the base64url-encoded string and writes the binary bytes to the underlying memory stream. </summary> <param name="encodedContent">The base64url-encoded content.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteBytes(System.Byte[])"> <summary> Writes the binary bytes to the underlying memory stream. </summary> <param name="bytes">The raw bytes to be written into the stream.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteCurrentJsonObject(Microsoft.OData.Json.IJsonReader,Microsoft.OData.Json.IJsonWriter)"> <summary> Writes the current Json object. </summary> <param name="reader">The Json reader providing the data.</param> <param name="jsonWriter">The Json writer writes data into memory stream.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteJsonContentAsync(Microsoft.OData.Json.IJsonReaderAsync)"> <summary> Asynchronously reads off the data of the starting Json object from the Json reader, and populate the data into the memory stream. </summary> <param name="reader"> The json reader pointing at the json structure whose data needs to be populated into an memory stream. </param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteBinaryContentAsync(System.String)"> <summary> Asynchronously decodes the base64url-encoded string and writes the binary bytes to the underlying memory stream. </summary> <param name="encodedContent">The base64url-encoded content.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteBytesAsync(System.Byte[])"> <summary> Asynchronously writes the binary bytes to the underlying memory stream. </summary> <param name="bytes">The raw bytes to be written into the stream.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchBodyContentReaderStream.WriteCurrentJsonObjectAsync(Microsoft.OData.Json.IJsonReaderAsync,Microsoft.OData.Json.IJsonWriterAsync)"> <summary> Asynchronously writes the current Json object. </summary> <param name="reader">The Json reader providing the data.</param> <param name="jsonWriter">The Json writer writes data into memory stream.</param> <returns>A task that represents the asynchronous write operation.</returns> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache"> <summary> Class for cache properties of a json object. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameId"> <summary> Property name for message Id in Json batch payload's message object. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameAtomicityGroup"> <summary> Property name for message atomicityGroup association in Json batch payload's message object. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameHeaders"> <summary> Property name for response headers in Json batch response. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameBody"> <summary> Property name for message body in Json batch payload's message object. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameDependsOn"> <summary> Property name for request execution dependency in Json batch request. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameMethod"> <summary> Property name for request HTTP method in Json batch request. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameUrl"> <summary> Property name for request URL in Json batch request. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.PropertyNameStatus"> <summary> Property name for response status in Json batch response. Property names definitions here are all in upper case to support case insensitivity. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.jsonReader"> <summary> The Json reader for reading payload item in Json format. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.asynchronousJsonReader"> <summary> The JSON reader for asynchronously reading payload item in Json format. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.listener"> <summary> The Json batch reader for batch processing. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.jsonProperties"> <summary> Cache for json properties. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.isStreamPopulated"> <summary> Whether the stream has been populated with body content from the operation request message. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.#ctor(Microsoft.OData.JsonLight.ODataJsonLightBatchReader)"> <summary> Constructor. </summary> <param name="jsonBatchReader">The Json batch reader.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.Create(Microsoft.OData.JsonLight.ODataJsonLightBatchReader)"> <summary> Creates a <see cref="T:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache"/> and subsequently scans the JSON object for known properties and caches them. </summary> <param name="jsonBatchReader">The JSON batch reader.</param> <returns>A <see cref="T:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache"/> instance.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.CreateAsync(Microsoft.OData.JsonLight.ODataJsonLightBatchReader)"> <summary> Asynchronously creates a <see cref="T:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache"/> and subsequently scans the JSON object for known properties and caches them. </summary> <param name="jsonBatchReader">The JSON batch reader.</param> <returns> A task that represents the asynchronous write operation. The value of the TResult parameter contains a <see cref="T:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache"/> instance. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.GetPropertyValue(System.String)"> <summary> Retrieves the value for the cached property. </summary> <param name="propertyName"> Name of the property.</param> <returns>Property value. Null if not found.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.CreateJsonPayloadBodyContentStream(System.String)"> <summary> Creates a batch reader stream backed by memory stream containing data the current Json object the reader is pointing at. Current supported data types are Json and binary types. </summary> <param name="contentTypeHeader">The content-type header value of the request.</param> <returns>The memory stream.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.Normalize(System.String)"> <summary> Normalization method for property name. Upper case conversion is used. </summary> <param name="propertyName">Name to be normalized.</param> <returns>The normalized name.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.ScanJsonProperties"> <summary> Wrapper method with validation to scan the Json object for known properties. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.CreateJsonPayloadBodyContentStreamAsync(System.String)"> <summary> Asynchronously creates a batch reader stream backed by memory stream containing data the current Json object the reader is pointing at. Current supported data types are Json and binary types. </summary> <param name="contentTypeHeader">The content-type header value of the request.</param> <returns> A task that represents the asynchronous operation. The value of the TResult parameter contains the wrapper stream backed by memory stream. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchPayloadItemPropertiesCache.ScanJsonPropertiesAsync"> <summary> Wrapper method with validation to asynchronously scan the JSON object for known properties. </summary> <returns>A task that represents the asynchronous read operation.</returns> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchReader"> <summary> Class for reading OData batch messages in json format. Also verifies the proper sequence of read calls on the reader. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.batchStream"> <summary>The batch stream used by the batch reader to divide a batch payload into parts.</summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.atomicGroups"> <summary> The cache to keep track of atomicity group information during json batch message reading. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.PropertyNameRequests"> <summary> Top-level attribute name for request arrays in Json batch format. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.PropertyNameResponses"> <summary> Top-level attribute name for response arrays in Json batch format. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.mode"> <summary> The reader's mode. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.messagePropertiesCache"> <summary> The cache for json property-value pairs of the current request or response message. </summary> </member> <member name="F:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.requestIds"> <summary> Collection for keeping track of unique atomic group ids and member request ids. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.#ctor(Microsoft.OData.JsonLight.ODataJsonLightInputContext,System.Boolean)"> <summary> Constructor. </summary> <param name="inputContext">The input context to read the content from.</param> <param name="synchronous">true if the reader is created for synchronous operation; false for asynchronous.</param> </member> <member name="T:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReaderMode"> <summary> Definition of modes for Json reader. </summary> </member> <member name="P:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.JsonLightInputContext"> <summary> Gets the reader's input context as real runtime type. </summary> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.GetCurrentGroupIdImplementation"> <summary> Gets the atomic group id for the current request. </summary> <returns>The group id for the current request. Null if current request is not in an atomic group.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.CreateOperationRequestMessageImplementation"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationRequestMessage"/> for reading the content of an operation in a batch request. </summary> <returns>The message that can be used to read the content of the batch request operation from.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReadAtStartImplementation"> <summary> Implementation of the reader logic when in state 'Start'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReadAtChangesetEndImplementation"> <summary> Implementation of the reader logic when in state 'ChangesetEnd'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReadAtOperationImplementation"> <summary> Implementation of the reader logic when in state 'Operation'. </summary> <returns>The batch reader state after the read.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.CreateOperationResponseMessageImplementation"> <summary> Returns the cached <see cref="T:Microsoft.OData.ODataBatchOperationResponseMessage"/> for reading the content of a batch response. </summary> <returns>The message that can be used to read the content of the batch response from.</returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ValidateDependsOnIds(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Validate the dependsOnIds. </summary> <param name="contentId">The context Id.</param> <param name="dependsOnIds">The dependsOn ids specifying current request's prerequisites.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReadAtStartImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'Start'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ReadAtOperationImplementationAsync"> <summary> Asynchronous implementation of the reader logic when in state 'Operation'. </summary> <returns> A task that represents the asynchronous read operation. The value of the TResult parameter contains the batch reader state after the read. </returns> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ValidateRequiredProperty(System.String,System.String)"> <summary> Validate that the property value is not null. </summary> <param name="propertyValue"> Value of the property.</param> <param name="propertyName"> Name of the property.</param> </member> <member name="M:Microsoft.OData.JsonLight.ODataJsonLightBatchReader.ValidateDependsOnId(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> & |