HelpPageSampleGenerator Class

 

This class will generate the samples for the help page.

Namespace:   Microsoft.WindowsAzure.Mobile.Service.Description.Samples
Assembly:  Microsoft.WindowsAzure.Mobile.Service (in Microsoft.WindowsAzure.Mobile.Service.dll)

System.Object
  Microsoft.WindowsAzure.Mobile.Service.Description.Samples.HelpPageSampleGenerator

type HelpPageSampleGenerator = class end

NameDescription
System_CAPS_pubmethodHelpPageSampleGenerator()

Initializes a new instance of the HelpPageSampleGenerator class.

NameDescription
System_CAPS_pubpropertyActionSamples

Gets the objects that are used directly as samples for certain actions.

System_CAPS_pubpropertyActualHttpMessageTypes

Gets CLR types that are used as the content of HttpRequestMessage or HttpResponseMessage.

System_CAPS_pubpropertySampleObjects

Gets the objects that are serialized as samples by the supported formatters.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetActionSample(String, String, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)

Search for samples that are provided directly through ActionSamples.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetSample(ApiDescription, SampleDirection)

Gets the request or response body samples.

System_CAPS_pubmethodGetSampleObject(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 ObjectGenerator.

System_CAPS_pubmethodGetSampleRequests(ApiDescription)

Gets the request body samples for a given ApiDescription.

System_CAPS_pubmethodGetSampleResponses(ApiDescription)

Gets the response body samples for a given ApiDescription.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, Collection<MediaTypeFormatter>)

Resolves the type of the action parameter or return value when HttpRequestMessage or HttpResponseMessage is used.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodWriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Writes the sample object using formatter.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: