HelpPageSampleGenerator Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Cette classe génère les exemples pour la page d’aide.
public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
- Héritage
-
HelpPageSampleGenerator
Constructeurs
HelpPageSampleGenerator() |
Initialise une nouvelle instance de la classe HelpPageSampleGenerator. |
Propriétés
ActionSamples |
Obtient les objets qui sont utilisés directement comme exemples pour certaines actions. |
ActualHttpMessageTypes |
Obtient les types CLR utilisés comme contenu de HttpRequestMessage ou HttpResponseMessage. |
SampleObjects |
Obtient les objets sérialisés en tant qu’exemples par les formateurs pris en charge. |
Méthodes
GetActionSample(String, String, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection) |
Recherchez des exemples fournis directement via ActionSamples. |
GetSample(ApiDescription, SampleDirection) |
Obtient les exemples de corps de requête ou de réponse. |
GetSampleObject(Type) |
Obtient l’exemple d’objet qui sera sérialisé par les formateurs. Tout d’abord, il examine .SampleObjects Si aucun exemple d’objet n’est trouvé, il essaiera d’en créer un à l’aide de ObjectGenerator. |
GetSampleRequests(ApiDescription) |
Obtient les exemples de corps de requête pour un donné System.Web.Http.Description.ApiDescription. |
GetSampleResponses(ApiDescription) |
Obtient les exemples de corps de réponse pour un donné System.Web.Http.Description.ApiDescription. |
ResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, Collection<MediaTypeFormatter>) |
Résout le type du paramètre d’action ou de la valeur de retour quand HttpRequestMessage ou HttpResponseMessage est utilisé. |
WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue) |
Écrit l’exemple d’objet à l’aide du formateur. |
S’applique à
Azure SDK for .NET