Share via


IODataPayloadUriConverter Interface

Definition

Supports custom conversion of URLs found in the payload.

public interface IODataPayloadUriConverter
type IODataPayloadUriConverter = interface
Public Interface IODataPayloadUriConverter
Derived

Remarks

This interface can be implemented on messages (see IODataRequestMessage and IODataResponseMessage). When a message implementing this interface is passed to an ODataMessageWriter or 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.

Methods

ConvertPayloadUri(Uri, Uri)

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.

Applies to