HelpPageSampleGenerator Class

Reference

Definition

Namespace:: Microsoft.WindowsAzure.Mobile.Service.Description.Samples

Assembly:: Microsoft.WindowsAzure.Mobile.Service.dll

Package:: WindowsAzure.MobileServices.Backend v1.0.478

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class will generate the samples for the help page.

public class HelpPageSampleGenerator

type HelpPageSampleGenerator = class

Public Class HelpPageSampleGenerator

Inheritance: Object
HelpPageSampleGenerator

Constructors

HelpPageSampleGenerator()

Initializes a new instance of the HelpPageSampleGenerator class.

Properties

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.
SampleObjects	Gets the objects that are serialized as samples by the supported formatters.

Methods

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 ObjectGenerator.
GetSampleRequests(ApiDescription)	Gets the request body samples for a given System.Web.Http.Description.ApiDescription.
GetSampleResponses(ApiDescription)	Gets the response body samples for a given System.Web.Http.Description.ApiDescription.
ResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, 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.

Applies to

Share via