MobileServiceClient Class

Reference

Definition

Namespace:: Microsoft.WindowsAzure.MobileServices

Assembly:: Microsoft.Azure.Mobile.Client.dll

Assembly:: Microsoft.WindowsAzure.Mobile.dll

Package:: Microsoft.Azure.Mobile.Client v4.2.0

Package:: WindowsAzure.MobileServices v1.3.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides basic access to a Microsoft Azure Mobile Service.

public class MobileServiceClient : IDisposable, Microsoft.WindowsAzure.MobileServices.IMobileServiceClient

type MobileServiceClient = class
    interface IMobileServiceClient
    interface IDisposable

Public Class MobileServiceClient
Implements IDisposable, IMobileServiceClient

Inheritance: Object
MobileServiceClient

Implements: IMobileServiceClient IDisposable

Constructors

MobileServiceClient()	This is for unit testing only
MobileServiceClient(IMobileServiceClientOptions)	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(String, HttpMessageHandler[])	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(String, String, HttpMessageHandler[])	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(String, String)	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(String)	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(Uri, HttpMessageHandler[])	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(Uri, String, HttpMessageHandler[])	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(Uri, String)	Initializes a new instance of the MobileServiceClient class.
MobileServiceClient(Uri)	Initializes a new instance of the MobileServiceClient class.

Properties

AlternateLoginHost	Alternate URI for login
ApplicationKey	Gets the Mobile Services application's name that is provided by the call to MobileServiceClient(...).
ApplicationUri	Gets the Uri to the Mobile Services application that is provided by the call to MobileServiceClient(...).
CurrentUser	The current authenticated user provided after a successful call to MobileServiceClient.Login().
DefaultDatabasePath	The location of any files we need to create for offline-sync
EventManager	The event manager that exposes and manages the event stream used by the mobile services types to publish and consume events.
InstallationId	The id used to identify this installation of the application to provide telemetry data.
LoginUriPrefix	Prefix for the login endpoints. If not set defaults to /.auth/login
MobileAppUri	Absolute URI of the Microsoft Azure Mobile App.
SerializerSettings	Gets or sets the settings used for serialization.
SyncContext	Instance of IMobileServiceSyncContext

Methods

Dispose()	Implemenation of IDisposable
Dispose(Boolean)	Implemenation of IDisposable for derived classes to use.
EnsureFileExists(String)	Ensures that a file exists, creating it if necessary
GetSyncTable(String)	Returns a IMobileServiceSyncTable instance, which provides untyped data operations for that table.
GetSyncTable<T>()	Returns a IMobileServiceSyncTable<T> instance, which provides strongly typed data operations for local table.
GetTable(String)	Returns a IMobileServiceTable instance, which provides untyped data operations for that table.
GetTable<T>()	Returns a IMobileServiceTable<T> instance, which provides strongly typed data operations for that table.
InvokeApiAsync(String, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST.
InvokeApiAsync(String, HttpContent, HttpMethod, IDictionary<String,String>, IDictionary<String,String>, CancellationToken)	Invokes a user-defined custom API of a Windows Azure Mobile Service using the specified HttpMethod. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync(String, HttpContent, HttpMethod, IDictionary<String,String>, IDictionary<String,String>)	Invokes a user-defined custom API of a Windows Azure Mobile Service using the specified HttpMethod. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync(String, HttpMethod, IDictionary<String,String>, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data will sent to through the query string.
InvokeApiAsync(String, HttpMethod, IDictionary<String,String>)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data will sent to through the query string.
InvokeApiAsync(String, JToken, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST, with support for sending HTTP content.
InvokeApiAsync(String, JToken, HttpMethod, IDictionary<String,String>, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP method. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync(String, JToken, HttpMethod, IDictionary<String,String>)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP method. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync(String, JToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST, with support for sending HTTP content.
InvokeApiAsync(String)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST.
InvokeApiAsync<T,U>(String, T, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST with support for sending HTTP content.
InvokeApiAsync<T,U>(String, T, HttpMethod, IDictionary<String,String>, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync<T,U>(String, T, HttpMethod, IDictionary<String,String>)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data can be sent though the HTTP content or the query string.
InvokeApiAsync<T,U>(String, T)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST with support for sending HTTP content.
InvokeApiAsync<T>(String, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST.
InvokeApiAsync<T>(String, HttpMethod, IDictionary<String,String>, CancellationToken)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data can be passed using the query string.
InvokeApiAsync<T>(String, HttpMethod, IDictionary<String,String>)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using the specified HTTP Method. Additional data can be passed using the query string.
InvokeApiAsync<T>(String)	Invokes a user-defined custom API of a Microsoft Azure Mobile Service using an HTTP POST.
LoginAsync(MobileServiceAuthenticationProvider, JObject)	Logs a user into a Windows Azure Mobile Service with the provider and optional token object.
LoginAsync(String, JObject)	Logs a user into a Microsoft Azure Mobile Service with the provider and optional token object.
Logout()	Log a user out.
LogoutAsync()	Log a user out.
RefreshUserAsync()	Refreshes access token with the identity provider for the logged in user.

Extension Methods

LoginWithMicrosoftAccountAsync(MobileServiceClient, String)

Log a user into a Mobile Services application given a Microsoft Account authentication token.

Applies to

Share via