Microsoft.Live.LiveConnectClient class

Exposes the primary functionality of the Microsoft account service endpoints, and manages token expiry.

Syntax

public class LiveConnectClient

Public Class LiveConnectClient

Members

The LiveConnectClient class has these types of members:

• Constructors

• Events

• Methods

• Properties

Constructors

The LiveConnectClient class has these constructors.

Constructor	Description
LiveConnectClient(LiveConnectSession)	Initializes a new instance of the LiveConnectClient class.

Events

The LiveConnectClient class has these events.

Event	Description
BackgroundDownloadCompleted	Raised after a file has been downloaded from Microsoft OneDrive to a Windows Phone isolated storage. [Windows Phone only]
BackgroundDownloadProgressChanged	Raised at indeterminate times while a file is downloading from Microsoft OneDrive to a Windows Phone isolated storage. [Windows Phone only]
BackgroundUploadCompleted	Raised after a file has been uploaded from a Windows Phone isolated storage to Microsoft OneDrive. [Windows Phone only]
BackgroundUploadProgressChanged	Raised at indeterminate times while a file is uploading from a Windows Phone isolated storage to Microsoft OneDrive. [Windows Phone only]
CopyCompleted	Raised when a CopyAsync operation is completed. [Windows Phone only]
DeleteCompleted	Raised when a DeleteAsync operation is completed. [Windows Phone only]
DownloadCompleted	Raised when a DownloadAsync operation is completed. [Windows Phone only]
DownloadProgressChanged	Raised every time a chunk of data is downloaded during a DownloadAsync operation. [Windows Phone only]
GetCompleted	Raised when a GetAsync operation is completed. [Windows Phone only]
MoveCompleted	Raised when a MoveAsync operation is completed. [Windows Phone only]
PostCompleted	Raised when a PostAsync operation is completed. [Windows Phone only]
PutCompleted	Raised when a PutAsync operation is completed. [Windows Phone only]
UploadCompleted	Raised when an UploadAsync operation is complete. [Windows Phone only]
UploadProgressChanged	Raised every time a chunk of data is uploaded during an UploadAsync operation. [Windows Phone only]

Methods

The LiveConnectClient class has these methods. It also inherits methods from the Object class.

Method	Description
AttachPendingTransfers	After an app starts or resumes, checks if any associated in-progress file download or upload requests are currently in progress. [Windows Phone only]
BackgroundDownloadAsync(String)	Performs a download of a file with a given path. [Windows Store app only]
BackgroundDownloadAsync(String, CancellationToken, IProgress<LiveOperationProgress>)	Performs a download of a file with a given path, cancellation token, and LiveOperationProgress. [Windows Store app only]
BackgroundDownloadAsync(String, IStorageFile)	Performs a download of a file with a given path and output file to hold the downloaded file contents. [Windows Store app only]
BackgroundDownloadAsync(String, IStorageFile, CancellationToken, IProgress<LiveOperationProgress>)	Performs a download of a file with a given path, cancellation token, LiveOperationProgress, and output file to hold the downloaded file contents. [Windows Store app only]
BackgroundDownloadAsync(String, Uri)	Begins downloading a file from Microsoft OneDrive to a Windows Phone isolated storage. [Windows Phone only]
BackgroundDownloadAsync(String, Uri, String)	Begins downloading a file from Microsoft OneDrive to a Windows Phone isolated storage. [Windows Phone only]
BackgroundUploadAsync(String, String, IInputStream, OverwriteOption)	Uploads a resource with a given path, file name, stream contents, and the option to overwrite an existing file. [Windows Store app only]
BackgroundUploadAsync(String, String, IInputStream, OverwriteOption, CancellationToken, IProgress<LiveOperationProgress>)	Uploads a resource with a given path, file name, stream contents, cancellation token, LiveOperationProgress, and the option to overwrite an existing file. [Windows Store app only]
BackgroundUploadAsync(String, String, IStorageFile, OverwriteOption)	Uploads a resource with a given path, file name, file contents, and the option to overwrite an existing file. [Windows Store app only]
BackgroundUploadAsync(String, String, IStorageFile, OverwriteOption, CancellationToken, IProgress<LiveOperationProgress>)	Uploads a resource with a given path, file name, file contents, cancellation token, LiveOperationProgress, and the option to overwrite an existing file. [Windows Store app only]
BackgroundUploadAsync(String, Uri, OverwriteOption)	Begins uploading a file from a Windows Phone isolated storage to Microsoft OneDrive. [Windows Phone only]
BackgroundUploadAsync(String, Uri, OverwriteOption, String)	Begins uploading a file from a Windows Phone isolated storage to Microsoft OneDrive. [Windows Phone only]
CopyAsync(String, String)	Copies the file from the given path to the destination path.
CopyAsync(String, String, CancellationToken)	Copies the file from the given path to the destination path and supports cancelling the operation. [Windows Store app only]
CopyAsync(String, String, Object)	Copies a file using the REST API, passing a string containing the path of the item to copy, a string with the destination path, and the current user state. [Windows Phone only]
CreateBackgroundDownloadAsync(String, IStorageFile)	Starts a file download from Microsoft OneDrive.
CreateBackgroundUploadAsync(String, String, IInputStream, OverwriteOption)	Performs an upload of a file with a given path.
CreateBackgroundUploadAsync(String, String, IStorageFile, OverwriteOption)	Performs an upload of a file with a given path.
DeleteAsync(String)	Deletes the file identified by its path.
DeleteAsync(String, CancellationToken)	Deletes the file with the given path and supports cancelling the operation. [Windows Store app only]
DeleteAsync(String, Object)	Deletes a file using the REST API for a given path and user state. [Windows Phone only]
DownloadAsync(String)	Downloads a file with a given path. [Windows Phone only]
DownloadAsync(String, Object)	Downloads a file with a given path and user state. [Windows Phone only]
GetAsync(String)	Gets the file at the specified path.
GetAsync(String, CancellationToken)	Gets the file at the specified path and allows the operation to be canceled. [Windows Store app only]
GetAsync(String, Object)	Gets the file at the specified path. [Windows Phone only]
GetCurrentBackgroundDownloadsAsync	Gets a list of the current pending downloads.
GetCurrentBackgroundUploadsAsync	Gets a list of the current pending uploads.
MoveAsync(String, String)	Moves a resource from a specified path to another location.
MoveAsync(String, String, CancellationToken)	Moves a resource from a specified path to another location and allows for cancellation. [Windows Store app only]
MoveAsync(String, String, Object)	Moves a resource from a specified path to another location using the REST reference. [Windows Phone only]
PostAsync(String, IDictionary<String, Object>)	Performs an asynchronous post operation for a given path and message request body.
PostAsync(String, IDictionary<String, Object>, CancellationToken)	Performs an asynchronous post operation for a given path, message request body, and cancellation token.
PostAsync(String, IDictionary<String, Object>, Object)	Performs an asynchronous post operation for a given path, body, and user state. [Windows Phone only]
PostAsync(String, String)	Performs an asynchronous post operation for a given path and message request body.
PostAsync(String, String, CancellationToken)	Performs an asynchronous post operation for a given path, message request body, and cancellation token.
PostAsync(String, String, Object)	Performs an asynchronous put for a given path and body. [Windows Phone only]
PutAsync(String, IDictionary<String, Object>)	Performs an asynchronous put that updates a resource with a given path and message body.
PutAsync(String, IDictionary<String, Object>, CancellationToken)	Performs an asynchronous put that updates a resource with a given path, message body, and cancellation token. [Windows Store app only]
PutAsync(String, IDictionary<String, Object>, Object)	Performs an asynchronous put of a resource for a given path and body. [Windows Phone only]
PutAsync(String, String)	Performs an asynchronous put that updates a resource with a given path and message body.
PutAsync(String, String, CancellationToken)	Performs an asynchronous put that updates a resource with a given path, message body, and cancellation token. [Windows Store app only]
PutAsync(String, String, Object)	Performs an asynchronous put for a given path and body. [Windows Phone only]
UploadAsync(String, String, Stream, OverwriteOption)	Performs an asynchronous upload of a resource with a given path, file name, stream contents, user state, and the option to overwrite an existing file. [Windows Phone only]
UploadAsync(String, String, Stream, OverwriteOption, Object)	Performs an asynchronous upload of a resource with a given path, file name, stream contents, and user state. [Windows Phone only]

Properties

The LiveConnectClient class has these properties.

Property	Access type	Description
BackgroundTransferPreferences	Read/write	Configures the usage preferences for performing data transfers in the background with the BackgroundDownloadAsync and BackgroundUploadAsync methods. [Windows Phone only]
Session	Read-only	Contains the current session data used by the LiveConnectClient class.

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	None supported [Windows Store apps only]
Minimum supported phone	Windows Phone 8
Namespace	Microsoft.Live
Assembly	Microsoft.Live.dll