mw.ForeignStructuredUpload(targetopt, apiconfigopt)

ForeignStructuredUpload

Constructor

new mw.ForeignStructuredUpload(targetopt, apiconfigopt) #

Used to represent an upload in progress on the frontend.

This subclass will upload to a wiki using a structured metadata system similar to (or identical to) the one on Wikimedia Commons.

See https://commons.wikimedia.org/wiki/Commons:Structured_data for a more detailed description of how that system works.

TODO: This currently only supports uploads under CC-BY-SA 4.0, and should really have support for more licenses.

Parameters:

Name Type Attributes Description
target string <optional>
apiconfig Object <optional>
Source:
Used to represent an upload in progress on the frontend.

Extends

Classes

BookletLayout
Class that encapsulates the process of uploading a file to MediaWiki.

Methods

addCategories(categories) #

Add categories to the upload.

Parameters:

Name Type Description
categories Array.<string>

Array of categories to which this upload will be added.
Source:
Add categories to the upload.

addDescription(language, description) #

Add a description to the upload.

Parameters:

Name Type Description
language string

The language code for the description's language. Must have a template on the target wiki to work properly.
description string

The description of the file.
Source:
Add a description to the upload.

clearCategories() #

Empty the list of categories for the upload.

Source:
Empty the list of categories for the upload.

clearDescriptions() #

Empty the list of descriptions for the upload.

Source:
Empty the list of descriptions for the upload.

finishStashUpload() → {jQuery.Promise} #

Finish a stash upload.

Inherited From:
Source:

Returns:

Type
jQuery.Promise
Finish a stash upload.

getApi() → {jQuery.Promise.<mw.Api>} #

Get the mw.Api instance used by this Upload object.

Inherited From:
Source:

Returns:

Type
jQuery.Promise.<mw.Api>
Get the mw.Api instance used by this Upload object.

getBasename(path) → {string} #

Gets the base filename from a path name.

Parameters:

Name Type Description
path string
Inherited From:
Source:

Returns:

Type
string
Gets the base filename from a path name.

getComment() → {string} #

Get the current value of the edit comment for the upload.

Overrides:
Source:

Returns:

Type
string
Get the current value of the edit comment for the upload.

getFile() → {HTMLInputElement|File|Blob} #

Get the file being uploaded.

Inherited From:
Source:

Returns:

Type
HTMLInputElement | File | Blob
Get the file being uploaded.

getFilename() → {string} #

Get the filename, to be finalized on upload.

Inherited From:
Source:

Returns:

Type
string
Get the filename, to be finalized on upload.

getImageInfo() → {Object|undefined} #

Get the imageinfo object for the finished upload. Only available once the upload is finished! Don't try to get it beforehand.

Inherited From:
Source:

Returns:

Type
Object | undefined
Get the imageinfo object for the finished upload.

getState() → {mw.Upload.State} #

Gets the state of the upload.

Inherited From:
Source:

Returns:

Type
mw.Upload.State
Gets the state of the upload.

getStateDetails() → {string} #

Gets details of the current state.

Inherited From:
Source:

Returns:

Type
string
Gets details of the current state.

getText() → {string} #

Get the text of the file page, to be created on upload. Brings together several different pieces of information to create useful text.

Overrides:
Source:

Returns:

Type
string
Get the text of the file page, to be created on upload.

getWatchlist() → {boolean} #

Get the boolean for whether the file will be watchlisted after upload.

Inherited From:
Source:

Returns:

Type
boolean
Get the boolean for whether the file will be watchlisted after upload.

loadConfig() → {jQuery.Promise} #

Get the configuration for the form and filepage from the foreign wiki, if any, and use it for this upload.

Source:

Returns:

Promise returning config object

Type
jQuery.Promise

Get the configuration for the form and filepage from the foreign wiki, if any, and use it for this upload.

setComment(comment) #

Set the edit comment for the upload.

Parameters:

Name Type Description
comment string
Inherited From:
Source:
Set the edit comment for the upload.

setDate(date) #

Set the date of creation for the upload.

Parameters:

Name Type Description
date Date
Source:
Set the date of creation for the upload.

setFile(file) #

Set the file to be uploaded.

Parameters:

Name Type Description
file HTMLInputElement | File | Blob
Inherited From:
Source:
Set the file to be uploaded.

setFilekey(filekey) #

Set the stashed file to finish uploading.

Parameters:

Name Type Description
filekey string
Inherited From:
Source:
Set the stashed file to finish uploading.

setFilename(filename) #

Set the filename, to be finalized on upload.

Parameters:

Name Type Description
filename string
Inherited From:
Source:
Set the filename, to be finalized on upload.

setFilenameFromFile() #

Sets the filename based on the filename as it was on the upload.

Inherited From:
Source:
Sets the filename based on the filename as it was on the upload.

setState(state, stateDetails) #

Sets the state and state details (if any) of the upload.

Parameters:

Name Type Description
state mw.Upload.State
stateDetails Object
Inherited From:
Source:
Sets the state and state details (if any) of the upload.

setText(text) #

Set the text of the file page, to be created on file upload.

Parameters:

Name Type Description
text string
Inherited From:
Source:
Set the text of the file page, to be created on file upload.

setWatchlist(watchlist) #

Set whether the file should be watchlisted after upload.

Parameters:

Name Type Description
watchlist boolean
Inherited From:
Source:
Set whether the file should be watchlisted after upload.

upload() → {jQuery.Promise} #

Upload the file directly.

Inherited From:
Source:

Returns:

Type
jQuery.Promise
Upload the file directly.

uploadToStash() → {jQuery.Promise} #

Upload the file to the stash to be completed later.

Inherited From:
Source:

Returns:

Type
jQuery.Promise
Upload the file to the stash to be completed later.