Home Reference Source Repository
public class | source

UploadTask

Extends:

src/core.js~APIFileTask → UploadTask

Uploads the message translations to the Smartling server.

Constructor Summary

Public Constructor
public

constructor(options: object)

Initializes a new instance of the class.

Member Summary

Public Members
public get

Value indicating whether content in the file is authorized (available for translation) in all locales.

public set

authorize(value: boolean): *

Sets a value indicating whether content in the file is authorized (available for translation) in all locales.

public get

The URL of the callback called when the file is 100% published for a locale.

public set

callbackURL(value: string): *

Sets the URL of the callback called when the file is 100% published for a locale.

public

The path to the message file.

public

The desired format for the download.

Method Summary

Public Methods
public

Uploads the original source content to the Smartling server.

Inherited Summary

From class FileTask
public static

Returns the file type corresponding to the specified file URI.

public

A value that uniquely identifies the file.

Public Constructors

public constructor(options: object) source

Initializes a new instance of the class.

Override:

FileTask#constructor

Params:

NameTypeAttributeDescription
options object
  • optional

An object specifying values used to initialize this instance.

Public Members

public get authorize: boolean source

Value indicating whether content in the file is authorized (available for translation) in all locales.

public set authorize(value: boolean): * source

Sets a value indicating whether content in the file is authorized (available for translation) in all locales.

public get callbackURL: string source

The URL of the callback called when the file is 100% published for a locale.

public set callbackURL(value: string): * source

Sets the URL of the callback called when the file is 100% published for a locale.

public file: string source

The path to the message file.

public fileType: string source

The desired format for the download.

Public Methods

public run(): Promise source

Uploads the original source content to the Smartling server.

Return:

Promise

Completes when the source file has been uploaded.