TransifexRunnerRemoteSettings<TSettingsType> Class

Summary

Defines common properties that can be used for all commands touching a remote location.
graph BT Type-->Base0["TransifexRunnerSettings<TSettingsType>"] Base0-->Base1["TransifexRunnerSettings"] click Base1 "/api/Cake.Transifex/TransifexRunnerSettings" Base1-->Base2["ToolSettings"] Type["TransifexRunnerRemoteSettings<TSettingsType>"] class Type type-node Derived0["TransifexPushSettings"]-->Type click Derived0 "/api/Cake.Transifex/TransifexPushSettings" Derived1["TransifexPullSettings"]-->Type click Derived1 "/api/Cake.Transifex/TransifexPullSettings"

Syntax

public class TransifexRunnerRemoteSettings<TSettingsType> : TransifexRunnerSettings<TSettingsType> 
    where TSettingsType : TransifexRunnerRemoteSettings<TSettingsType>

Type Parameters

Name Description
TSettingsType The type of settings that inherits from this class.

Constructors

Name Summary
TransifexRunnerRemoteSettings(string) Initializes a new instance of the TransifexRunnerRemoteSettings<TSettingsType> class.

Properties

Name Value Summary
Branch string
Gets or sets the branch to use when pulling/pushing translations. Source files and translations pushed/updated on other branches will not be pulled.
Force bool
Gets or sets a value indicating whether to force the command event if the resource exists.
Languages string
Gets or sets the languages you want to push/pull. (defaults to all).
NoInteractive bool
Gets or sets a value indicating whether to require user input when forcing a push/pull.
Parallel bool
Gets or sets a value indicating whether translations/sources should be pushed/pulled in parallel.
SkipErrors bool
Gets or sets a value indicating whether to continue with the command even if an error ocurs.
UseGitTimestamps bool
Gets or sets a value indicating whether to use git timestamps when comparing commited files timestamp with corresponding file on transifex.
UseXliff bool
Gets or sets a value indicating whether use the xliff format.

Methods

Name Value Summary
GetValue<TValue>(string, TValue) TValue
Gets the stored value with the specified key.
GetValue<TValue>(string) TValue
Gets the stored value with the specified key.
SetValue(string, object) void
Stores the specified value with the specified key.

Extension Methods

Name Value Summary
Dump<TransifexRunnerRemoteSettings<TSettingsType>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TransifexRunnerRemoteSettings<TSettingsType>>(TransifexRunnerRemoteSettings<TSettingsType>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TransifexRunnerRemoteSettings<TSettingsType>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TransifexRunnerRemoteSettings<TSettingsType>>(string) void
Requires the Cake.Issues addin
ThrowIfNull<TransifexRunnerRemoteSettings<TSettingsType>>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TransifexRunnerRemoteSettings<TSettingsType>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin

See Also