Microsoft.WindowsAzure.Mobile.Service Namespace

 

Implements the core behaviors of a Mobile Services .NET backend service.

Classes

	Class	Description
	AlertProperties	The "alert" property contains properties specific to the alert in a notification targeting Apple Push Notification Service (APNS). It is intended to be used from the ApplePushMessage class.
	ApiServices	The ApiServices class provides commonly used context information which can be used within ApiController and IScheduledJob instances. For ApiController instances it is injected by the Dependency Injection engine, either using property injection or constructor injection. For IScheduledJob instances it is injected before the job is executed.
	ApplePushMessage	The ApplePushMessage helps generating a notification payload targeting Apple Push Notification Service. Notifications can be sent using the PushClient class which is available from the ApiServices class.
	ApsProperties	The "aps" property contains the definition of a notification targeting Apple Push Notification Service (APNS). It is intended to be used from the ApplePushMessage class.
	ClearDatabaseSchemaAlways<TContext>	An implementation of IDatabaseInitializer<TContext> that will DELETE all resources (e.g. tables, views, functions, and procedures) within a given database schema and re-seed the database regardless of whether the database model has changed. This implementation of IDatabaseInitializer<TContext> is useful if the current user only has permission to access resources within a particular database schema and not the entire database.
	ClearDatabaseSchemaIfModelChanges<TContext>	An implementation of IDatabaseInitializer<TContext> that will DELETE all resources (e.g. tables, views, functions, and procedures) within a given database schema, and optionally re-seed the database only if the model has changed since the database was created. This implementation of IDatabaseInitializer<TContext> is useful if the current user only has permission to access resources within a particular database schema and not the entire database.
	CompositeTableKey	A CompositeTableKey contains one or more keys used to identify a single row in a table. The string format of a CompositeTableKey is a comma separated list (without LWS) of optionally single-quoted terms. The terms only have to be quoted if they contain a comma.
	ConfigBuilder	The ConfigBuilder class is responsible for initializing the service including ASP.NET Web API, Autofac, and OWIN. The default ConfigBuilder implementation configures the service using default settings but an application can customize this in multiple ways: By providing a ConfigOptions with custom settings; by providing an Action<T1, T2> which can configure the dependency injection engine; or by providing an entirely different IConfigBuilder implementation.
	ConfigOptions	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.
	ConnectionSettings	This class provides configuration information for connection strings.
	DocumentData	An abstract implementation of the ITableData interface indicating how the system properties for a given table data model are to be serialized when communicating with clients using Mongo as the backend store. The uniform serialization of system properties ensures that the clients can process the system properties uniformly across platforms. Concrete entity framework models can derive from this base class in order to support the system properties.
	EntityContext	The EntityContext is an abstract base class which provides the same functionality as the DbContext scaffolded by Visual Studio. It is optional to use this base class instead of the scaffolded code when using a TableController<TData>.
	EntityData	An abstract implementation of the ITableData interface indicating how the system properties for a given table data model are to be serialized when communicating with clients when using Entity Framework for accessing the backend store. The uniform serialization of system properties ensures that the clients can process the system properties uniformly across platforms. Concrete entity framework models can derive from this base class in order to support the system properties.
	EntityDomainManager<TData>	Provides an IDomainManager<TData> implementation targeting SQL as the backend store using Entity Framework. In this model, there is a 1:1 mapping between the data object (DTO) exposed through a TableController<TData> and the domain model. The MappedEntityDomainManager<TData, TModel> is the recommended IDomainManager<TData> for situations where there is not a 1:1 relationship between the Data Object (DTO) and the domain model managed by SQL.
	GooglePushMessage	The GooglePushMessage helps generating a notification payload targeting Google Cloud Messaging for Chrome (GCM). Notifications can be sent using the PushClient class which is available from the ApiServices class.
	LogCategories	Optional log categories which can be used by the service when logging messages. The category can be used to filter log messages in post processing as well as in which messages are logged (see ConfigOptions for more details.
	MappedEntityDomainManager<TData, TModel>	Provides an IDomainManager<TData> implementation targeting SQL as the backend store using Entity Framework where there is not a 1:1 mapping between the data object (DTO) exposed through a TableController<TData> and the domain model managed by SQL. See EntityDomainManager<TData> for situations where there is a 1:1 relationship between the Data Object (DTO) and the domain model managed by SQL.
	MongoDomainManager<TData>.MongoContext	Contains the reusable (and thread-safe) objects for accessing MongoDB.
	MongoDomainManager<TData>	Provides an IDomainManager<TData> implementation targeting Mongo as the backend store.
	MpnsPushMessage	The MpnsPushMessage class helps in generating a notification payload targeting Microsoft Push Notification Services. Notifications can be sent using the PushClient class which is available from the ApiServices class.
	MvcApplication
	ScheduledJob	Provides a base class for scheduled jobs to be executed as part of the service.
	ServiceConfig	The ServiceConfig is a static class that kicks of the configuration process of a service.
	ServiceSettingsDictionary	Contains settings for a service such as the name, authentication provider information, connection strings, etc. The ServiceSettingsDictionary provides typed properties for known settings such as Name and Key as well as IDictionary<TKey, TValue> access for all other settings.
	SqlFuncs
	StorageData	An abstract implementation of the ITableData interface required by TableController<TData> as well as an implementation of TableEntity required by Azure Table Storage. It provides a default mapping from the TableEntity properties including partition key, row key, and timestamp into the corresponding properties on ITableData.
	StorageDomainManager<TData>	Provides an IDomainManager<TData> implementation targeting Azure Table Storage as the backend store.
	TableController<TData>	Provides a common ApiController abstraction for Table Controllers.
	TemplatePushMessage	The ApplePushMessage helps generating a notification payload targeting devices that have registered with a template registration. A template lets the device specify the shape of notifications that it wants to receive including a set of keywords which it wants the sender to fill in. Instead of the sender building the entire notification, it simply sets the keyword values. The Notification Hub will then build a notification using the particular template registered by device and the keywords provided by the sender. This makes it much easier to send notifications regardless of the platform of the receiver. The keywords defined by the TemplatePushMessage class can be sent using the PushClient class which is available from the ApiServices class.
	TileBinding	This class represents the binding element of a Windows Notification tile, see https://msdn.microsoft.com/library/windows/apps/hh761491.aspx for details. This class is intended for use as part of the WindowsPushMessage class.
	TileImage	This class represents the image element of a Windows Notification tile, see https://msdn.microsoft.com/library/windows/apps/hh761491.aspx for details. This class is intended for use as part of the WindowsPushMessage class.
	TileText	This class represents the text element of a Windows Notification tile, see https://msdn.microsoft.com/library/windows/apps/hh761491.aspx for details. This class is intended for use as part of the WindowsPushMessage class.
	WindowsPushMessage	The WindowsPushMessage helps generating a notification payload targeting Windows Push Notification Services. Notifications can be sent using the PushClient class which is available from the ApiServices class.

Return to top