IODataUrlResolver Interface
Supports custom resolution of URLs found in the payload.
Namespace: Microsoft.Data.OData
Assembly: Microsoft.Data.OData (in Microsoft.Data.OData.dll)
Syntax
'Declaration
Public Interface IODataUrlResolver
'Usage
Dim instance As IODataUrlResolver
public interface IODataUrlResolver
public interface class IODataUrlResolver
type IODataUrlResolver = interface end
public interface IODataUrlResolver
The IODataUrlResolver type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ResolveUrl | Implements a custom URL resolution scheme. This method returns null if no custom resolution is desired. If the method returns a non-null URL that value will be used without further validation. |
Top
Remarks
This interface can be implemented on messages (see IODataRequestMessage and IODataRequestMessage). When a message implementing this interface is passed to an IODataRequestMessage or IODataRequestMessage, the message writer/reader will use this interface for custom URL resolution. On writers this means that whenever a URI is written into the payload the resolution method on this interface is called to resolve a base URI and a payload URI to the actual URI to be written to the payload. If the method returns null from a resolution call the default resolution 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 resolution method returns null the default resolution kicks in.