BackgroundCopyJob Class

Provides methods and properties to add files to the job, set the priority level of the job, determine the state of the job, and to start and stop the job.

Inheritance Hierarchy

SystemObject
usis.Net.BitsBackgroundCopyJob

Namespace: usis.Net.Bits
Assembly: usis.Net.Bits (in usis.Net.Bits.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C++

Copy

public sealed class BackgroundCopyJob : IDisposable

Public NotInheritable Class BackgroundCopyJob
	Implements IDisposable

public ref class BackgroundCopyJob sealed : IDisposable

[<SealedAttribute>]
type BackgroundCopyJob =  
    class
        interface IDisposable
    end

The BackgroundCopyJob type exposes the following members.

Properties

	Name	Description
	Description	Gets or sets the description of the job.
	DisplayName	Gets or sets the display name that identifies the job.
	ErrorCount	Gets the number of times BITS tried to transfer the job and an error occurred.
	FileAcl	Gets or sets the flags that identify the owner and ACL information to maintain when transferring a file using SMB.
	HttpOptions	Gets the HTTP options to specify client certificates for certificate-based client authentication and custom headers for HTTP requests.
	Id	Gets the identifier of the job in the queue.
	JobType	Gets the type of transfer being performed, such as a file download or upload.
	MaximumDownloadTime	Gets or sets the maximum time that BITS will spend transferring the files in the job.
	MinimumRetryDelay	Gets or sets the minimum length of time that BITS waits after encountering a transient error condition before trying to transfer the file.
	NoProgressTimeout	Gets or sets the length of time that BITS tries to transfer the file after a transient error condition occurs. If there is progress, the timer is reset.
	Notifications	Gets the event notification flags for your application.
	NotifyCommandLine	Gets or sets the program to execute when the job enters the error or transferred state.
	Owner	Gets the identity of the job's owner.
	OwnerElevationState	Gets a value that determines if the token of the owner was elevated at the time they created or took ownership of the job.
	OwnerIntegrityLevel	Gets the integrity level of the token of the owner that created or took ownership of the job.
	PeerCachingOptions	Gets or sets options that determine if the files of the job can be cached and served to peers and if BITS can download content for the job from peers.
	Priority	Gets or sets the priority level for the job.
	ProxySettings	Gets or sets the proxy information that the job uses to transfer the files.
	ReplyFileName	Gets or sets the name of the file to contain the reply data of an upload-reply job.
	State	Gets the state of the job.

Top

Methods

	Name	Description
	AddFile(String, String)	Adds a single file to the job.
	AddFile(Uri, String)	Adds a single file to the job.
	AddFile(String, String, BackgroundCopyFileRange)	Adds a file to a download job and specifies the ranges of the file you want to download.
	AddFile(Uri, String, BackgroundCopyFileRange)	Adds a file to a download job and specifies the ranges of the file you want to download.
	AddFile(String, String, Int64, Int64)	Adds a file to a download job and specifies the range of the file you want to download.
	AddFile(Uri, String, Int64, Int64)	Adds a file to a download job and specifies the range of the file you want to download.
	AddFiles	Adds multiple files to the job.
	Cancel	Deletes the job from the transfer queue and removes related temporary files from the client (downloads) and server (uploads).
	Complete	Ends the job and saves the transferred files on the client.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	EnumerateFiles	Enumerates the files in the job.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the BackgroundCopyJob class. (Overrides ObjectFinalize.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RemoveCredentials	Removes credentials set by the SetCredentials(BackgroundCopyAuthenticationTarget, BackgroundCopyAuthenticationScheme, String, String) method.
	ReplaceRemotePrefix	Replaces the beginning text of all remote names in the download job with the specified string.
	Resume	Activates a new job or restarts a job that has been suspended.
	RetrieveError	Retrieves error informations after an error occurs.
	RetrieveProgress	Retrieves job-related progress information, such as the number of bytes and files transferred.
	RetrieveReplyData	Retrieves the reply data from the server application.
	RetrieveReplyProgress	Retrieves progress information that indicates how many bytes of the reply file have been downloaded to the client.
	RetrieveTimes	Retrieves job-related time stamps, such as the time that the job was created or last modified.
	SetCredentials	Specifies the credentials to use for a proxy or remote server user authentication request.
	Suspend	Suspends a job. New jobs, jobs that are in error, and jobs that have finished transferring files are automatically suspended.
	TakeOwnership	Changes ownership of the job to the current user.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)

Top

Events

	Name	Description
	Failed	Occurs when the state of the job changes to Error.
	FileTransferred	Occurs when BITS successfully finishes transferring a file.
	Modified	Occurs when a job is modified.
	Transferred	Occurs when all of the files in the job have successfully transferred.

Top

Extension Methods

	Name	Description
	GetErrorInfo	Gets error informations after an error occurs. (Defined by BackgroundCopyJobExtensions.)
	GetPercentBytesTransferred	Gets the percentage of bytes transferred. (Defined by BackgroundCopyJobExtensions.)

Top

Reference

usis.Net.Bits Namespace

SystemIDisposable