HelpPageSampleGenerator クラス

定義

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

このクラスは、ヘルプページのサンプルを生成します。

public class HelpPageSampleGenerator

type HelpPageSampleGenerator = class

Public Class HelpPageSampleGenerator

HelpPageSampleGenerator クラスの新しいインスタンスを初期化します。

ActionSamples	特定のアクションのサンプルとして直接使用されるオブジェクトを取得します。
ActualHttpMessageTypes	またはのコンテンツとして使用される CLR 型を HttpRequestMessage 取得します HttpResponseMessage。
SampleObjects	サポートされているフォーマッタによってサンプルとしてシリアル化されるオブジェクトを取得します。

GetActionSample(String, String, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)	を使用して直接提供されるサンプルを ActionSamples検索します。
GetSample(ApiDescription, SampleDirection)	要求または応答本文のサンプルを取得します。
GetSampleObject(Type)	フォーマッタによってシリアル化されるサンプルオブジェクトを取得します。まず、を見 SampleObjectsていきます。サンプルオブジェクトが見つからない場合は、を使用して ObjectGenerator作成しようとします。
GetSampleRequests(ApiDescription)	指定 System.Web.Http.Description.ApiDescriptionしたの要求本文のサンプルを取得します。
GetSampleResponses(ApiDescription)	指定 System.Web.Http.Description.ApiDescriptionしたの応答本文のサンプルを取得します。
ResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, Collection<MediaTypeFormatter>)	または HttpResponseMessage が使用されている場合に、アクションパラメーターまたは戻り値の型をHttpRequestMessage解決します。
WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)	フォーマッタを使用してサンプルオブジェクトを書き込みます。