Class UserAgentDocumentOptions

Provides programmatic configuration for the UserAgentDocumentFilter class.

public class UserAgentDocumentOptions : IParameterObject

Constructors

Initializes a new instance of the UserAgentDocumentOptions class.

public UserAgentDocumentOptions()

The following table shows the initial property values for an instance of UserAgentDocumentOptions.

Property	Initial Value
Description	`The identifier of the calling client.`
Example	`Your-Awesome-Client/1.0.0`
Required	`false`

Gets or sets the description of the User-Agent field.

public string Description { get; set; }

Gets or sets the example to associate with the User-Agent field.

public string Example { get; set; }

Gets or sets whether the User-Agent field is mandatory.

public bool Required { get; set; }