HelpPageSampleGenerator.GetSample Method

Gets the request or response body samples.
Public Overridable Function GetSample( _ 
ByVal api As ApiDescription, _ 
ByVal sampleDirection As SampleDirection
) As IDictionary(Of MediaTypeHeaderValue, Object)
This language is not supported or no code example is available.
public virtual IDictionary<MediaTypeHeaderValue, object> GetSample( 
ApiDescription api
SampleDirection sampleDirection 
)
This language is not supported or no code example is available.
public:  
virtual IDictionary<MediaTypeHeaderValue^, object^>^ GetSample( 
ApiDescription^ api
SampleDirection sampleDirection 
)
This language is not supported or no code example is available.
JScript does not support generic types and methods.
This language is not supported or no code example is available.

Parameters

api
ApiDescription

The ApiDescription.

sampleDirection
SampleDirection

The value indicating whether the sample is for a request or for a response.

Return Value

IDictionary<MediaTypeHeaderValue, object>

The samples keyed by media type.

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8

In this article

Definition