ConfigOptions Class

 

The ConfigOptions class provides a mechanism for setting various configuration options for the service. It can be passed in as an argument to the ConfigBuilder.

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

Inheritance Hierarchy

System.Object
  Microsoft.WindowsAzure.Mobile.Service.ConfigOptions

Syntax

public class ConfigOptions
public ref class ConfigOptions 
type ConfigOptions = class end
Public Class ConfigOptions

Constructors

Name Description
System_CAPS_pubmethod ConfigOptions()

Initializes a new instance of the ConfigOptions class.

Properties

Name Description
System_CAPS_pubproperty CachePolicy

Gets or sets the cache policy describing the HTTP caching headers cache response headers to include in an HttpResponseMessage if no HTTP caching headers have been previously added. The default CachePolicy is set to "no-cache" but can be changed here. If the available cache policies are not sufficient then it is possible to add a custom ICachePolicyProvider to the dependency injection engine.

System_CAPS_pubproperty CorsPolicy

Gets or sets an attribute used as policy for Cross-Origin requests.

System_CAPS_pubproperty DiagnosticsAuthorization

Gets or sets the minimum required authorization required to access service diagnostics information. The service diagnostics information is provided by the StatusReporter instances registered with the dependency injection engine.

System_CAPS_pubproperty ExcludedTraceCategories

Sets the set of trace categories that are excluded from being logged. Each trace has a "Category" indicating the origin (i.e. the "source") of the trace. An application may use the LogCategories as suggested categories, or simply leave out the category which will use the value provided by the CallerMemberNameAttribute. A log with a category that matches any of the excluded prefixes will not get logged. By default system logs are not logged to the application logs. This is achieved by excluding logs starting with the prefix " Service. ". If clearing this exclusion, the application will see all system logs in addition to any other logs logged by the application.

System_CAPS_pubproperty LoginProviders

Sets the ILoginProvider implementations that are participating in the Azure Mobile Service authentication process. The set includes the list of ILoginProvider implementations that are registered by default. The default set can be replaced or augmented by additional ILoginProvider implementations. In order for an entry to be registered as a login provider, it must be a public, visible, non-abstract implementation of ILoginProvider.

System_CAPS_pubproperty MinimumTraceLevel

Gets or sets the minimum TraceLevel for log entries that will get logged. Logs with a TraceLevel below this level will be ignored. The default for this property is Info.

System_CAPS_pubproperty Properties

Gets the properties associated with this instance.

System_CAPS_pubproperty PushAuthorization

Gets or sets the minimum required authorization required to register for and receive push notifications using Notification Hub.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Thread Safety

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

See Also

Microsoft.WindowsAzure.Mobile.Service Namespace

Return to top