HelpPageSampleGenerator Class

Namespace: API_NetFramework.Areas.HelpPage
Assembly: EDOKAAPI_NetFramework (in EDOKAAPI_NetFramework.dll)

This class will generate the samples for the help page.

C++

JScript

Copy

Public Class HelpPageSampleGenerator

This language is not supported or no code example is available.

C++

JScript

Copy

public class HelpPageSampleGenerator

This language is not supported or no code example is available.

C++

JScript

Copy

public ref class HelpPageSampleGenerator

This language is not supported or no code example is available.

C++

JScript

Copy

public class HelpPageSampleGenerator

This language is not supported or no code example is available.

	Name	Description
	HelpPageSampleGenerator()	Initializes a new instance of the HelpPageSampleGenerator class.

	Name	Description
	ActionSamples	Gets the objects that are used directly as samples for certain actions.
	ActualHttpMessageTypes	Gets CLR types that are used as the content of HttpRequestMessage or HttpResponseMessage.
	SampleObjectFactories	Gets factories for the objects that the supported formatters will serialize as samples. Processed in order, stopping when the factory successfully returns a non-<default> object.
	SampleObjects	Gets the objects that are serialized as samples by the supported formatters.

	Name	Description
	GetActionSample(string, string, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)	Search for samples that are provided directly through ActionSamples.
	GetSample(ApiDescription, SampleDirection)	Gets the request or response body samples.
	GetSampleObject(Type)	Gets the sample object that will be serialized by the formatters. First, it will look at the SampleObjects. If no sample object is found, it will try to create one using DefaultSampleObjectFactory (which wraps an ObjectGenerator) and other factories in SampleObjectFactories.
	GetSampleRequests(ApiDescription)	Gets the request body samples for a given ApiDescription.
	GetSampleResponses(ApiDescription)	Gets the response body samples for a given ApiDescription.
	ResolveHttpRequestMessageType(ApiDescription)	Resolves the actual type of ObjectContent<T> passed to the HttpRequestMessage in an action.
	ResolveType(ApiDescription, string, string, IEnumerable<String>, SampleDirection, out Collection<MediaTypeFormatter>)	Resolves the type of the action parameter or return value when HttpRequestMessage or HttpResponseMessage is used.
	WriteSampleObjectUsingFormatter(MediaTypeFormatter, object, Type, MediaTypeHeaderValue)	Writes the sample object using formatter.

	Name	Description
	NameOf(this object)	(Defined by NLogHelper).

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