ChunkedUploadSource Class

This is preliminary documentation and is subject to change.

A WikiUploadSource that enables chunked stashing and performs final upload by filekey. (MW 1.19+)

Inheritance Hierarchy

SystemObject
WikiClientLibrary.FilesWikiUploadSource
WikiClientLibrary.FilesChunkedUploadSource

Namespace: WikiClientLibrary.Files
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e

Syntax

C++

Copy

public class ChunkedUploadSource : WikiUploadSource

Public Class ChunkedUploadSource
	Inherits WikiUploadSource

Dim instance As ChunkedUploadSource

public ref class ChunkedUploadSource : public WikiUploadSource

type ChunkedUploadSource = 
    class
        inherit WikiUploadSource
    end

The ChunkedUploadSource type exposes the following members.

Constructors

	Name	Description
	ChunkedUploadSource(WikiSite, Stream)	Initialize an instance from a Stream.
	ChunkedUploadSource(WikiSite, Stream, String)	Initialize an instance from a Stream.

Top

Properties

	Name	Description
	DefaultChunkSize	The chunk size to be used when calling the StashNextChunkAsync overloads without explicitly specifying chunk size.
	FileKey	When IsStashed is true, gets the filekey used for file upload.
	FileName	The file name used in the stashing requests.
	IsStashed	Determines whether the file has been stashed completely.
	IsStashing	Determines whether a chunk is currently uploading for stashing.
	Site
	SourceStream	The source stream containing the content to be uploaded.
	TotalSize	Gets the total size of the file to be uploaded.
	UploadedSize	Gets the size of the uploaded part of file.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetUploadParameters	Gets the additional fields that will override the default action=upload parameters. (Overrides WikiUploadSourceGetUploadParameters(SiteInfo))
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	StashNextChunkAsync
	StashNextChunkAsync(CancellationToken)
	StashNextChunkAsync(Int32)
	StashNextChunkAsync(Int32, CancellationToken)	Stash the next chunk in the stream.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString)

Top

Remarks

Since uploading a huge file in a single HTTP POST can be unreliable, MW upload API also supports a chunked upload mode, where you make multiple requests with portions of the file. This is available in MediaWiki 1.20 and above, although prior to version 1.25, SVGs could not be uploaded via chunked uploading.

See https://www.mediawiki.org/wiki/API:Upload#Chunked_uploading .

Before you can use this class with UploadAsync(WikiSite, String, WikiUploadSource, String, Boolean, AutoWatchBehavior, CancellationToken), you need to stash the whole stream in chunks to the server with StashNextChunkAsync or its overloads.

Reference

WikiClientLibrary.Files Namespace