BackgroundTransferContentPart Class

Definition

Namespace:

Windows.Networking.BackgroundTransfer

Represents a content part of a multi-part transfer request. Each BackgroundTransferContentPart object can represent either a single string of text content or a single file payload, but not both.

public ref class BackgroundTransferContentPart sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(Windows.Networking.BackgroundTransfer.IBackgroundTransferContentPartFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class BackgroundTransferContentPart final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Networking.BackgroundTransfer.IBackgroundTransferContentPartFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class BackgroundTransferContentPart

function BackgroundTransferContentPart(name, fileName)

Public NotInheritable Class BackgroundTransferContentPart

Inheritance

Object Platform::Object IInspectable BackgroundTransferContentPart

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	internetClient internetClientServer privateNetworkClientServer

Examples

The following example demonstrates how to configure and begin a multi-part upload operation.

var upload = null;
var promise = null;

function MultipartUpload (uriString, files) {
    try {

        var uri = Windows.Foundation.Uri(uriString);
        var uploader = new Windows.Networking.BackgroundTransfer.BackgroundUploader();
        var contentParts = [];
        files.forEach(function (file, index) {
            var part = new Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart("File" + index, file.name);
            part.setFile(file);
            contentParts.push(part);
        });

        // Create a new upload operation.
        uploader.createUploadAsync(uri, contentParts).then(function (uploadOperation) {
            // Start the upload and persist the promise to be able to cancel the upload.
            upload = uploadOperation;
            promise = uploadOperation.startAsync().then(complete, error, progress);
        });
    } catch (err) {
        displayError(err);
    }
};

Constructors

BackgroundTransferContentPart()	Creates a BackgroundTransferContentPart object.
BackgroundTransferContentPart(String, String)	Creates a BackgroundTransferContentPart object that identifies the file content and the name of the file that it represents.
BackgroundTransferContentPart(String)	Creates a BackgroundTransferContentPart object that identifies the content it represents.

Methods

SetFile(IStorageFile)	Sets the source file for a BackgroundTransferContentPart containing the file for upload.
SetHeader(String, String)	Sets content disposition header values that indicate the nature of the information that this BackgroundTransferContentPart represents.
SetText(String)	Use this method to set text information that the BackgroundTransferContentPart represents.

See also

• CreateDownload(Uri, IStorageFile, IStorageFile)
• CreateUploadAsync
• Background transfer sample
• Background transfer sample (Windows 8.x)