HelpPageSampleGenerator..::..GetSample Method

Gets the request or response body samples.

Namespace: JiwaWebAPI.Areas.HelpPage
Assembly: JiwaWebAPI (in JiwaWebAPI.dll)

Syntax

public virtual IDictionary<MediaTypeHeaderValue, Object> GetSample(
	ApiDescription api,
	SampleDirection sampleDirection
)

Public Overridable Function GetSample ( _
	api As ApiDescription, _
	sampleDirection As SampleDirection _
) As IDictionary(Of MediaTypeHeaderValue, Object)

public:
virtual IDictionary<MediaTypeHeaderValue^, Object^>^ GetSample(
	ApiDescription^ api, 
	SampleDirection^ sampleDirection
)

Parameters

api: Type: ApiDescription
The ApiDescription.

sampleDirection: Type: JiwaWebAPI.Areas.HelpPage..::..SampleDirection
The value indicating whether the sample is for a request or for a response.

Return Value

The samples keyed by media type.

See Also

HelpPageSampleGenerator Class

JiwaWebAPI.Areas.HelpPage Namespace