import {DownloadTask} from '@aquafadas/gulp-smartling/src/tasks/download_task.js'

public class | source

DownloadTask

src/core.js~API → FileTask → DownloadTask

Downloads the message translations from the Smartling server.

Constructor Summary

Public Constructor
public	constructor(options: object) Initializes a new instance of the class.

Public Members
public	filePattern: string The pattern indicating the target path of the downloaded files (e.g.
public get	includeOriginalStrings: boolean Value indicating whether to return the original string or an empty string when no translation is available.
public set	includeOriginalStrings(value: boolean): * Sets a value indicating whether to return the original string or an empty string when no translation is available.
public	locales: string[] The list of locales to be downloaded.
public get	retrievalType: string The desired format for the download.
public set	retrievalType(value: string): * Sets the desired format for the download.

Public Methods
public	run(): Promise Downloads the message translations from the Smartling server.

From class FileTask
public static	getFileTypeFromURI(fileURI: string): string Returns the file type corresponding to the specified file URI.
public	fileURI: string A value that uniquely identifies the file.

Initializes a new instance of the class.

Name	Type	Attribute	Description
options	object	optional	An object specifying values used to initialize this instance.

The pattern indicating the target path of the downloaded files (e.g. path/to/i18n/{{locale}}.json).

Value indicating whether to return the original string or an empty string when no translation is available.

Sets a value indicating whether to return the original string or an empty string when no translation is available.

The list of locales to be downloaded.

The desired format for the download.

Sets the desired format for the download.

Downloads the message translations from the Smartling server.

Completes when the message translations have been downloaded.