Msi (SetupBuilder 3.4.6 API)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - com.inet.gradle.setup.abstracts.AbstractTask
    - - com.inet.gradle.setup.abstracts.AbstractSetupTask
      - com.inet.gradle.setup.msi.Msi

All Implemented Interfaces:

SetupSources, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
```
public class Msi
extends AbstractSetupTask
```
The msi Gradle task. It build a msi setup for Windows.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Msi.InstallScope
Possible values for install scope
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  org.gradle.api.Task.Namer

Nested Classes
Modifier and Type	Class and Description
`static class`	`Msi.InstallScope` Possible values for install scope

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor and Description

Msi()
Create a new instance.

Constructors
Constructor and Description
`Msi()` Create a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`build()` The platform depending build.
`java.lang.String`	`getArch()` Get the architecture of the installer.
`java.io.File`	`getBannerBmp()` Get the file of the banner or null
`java.io.File`	`getDialogBmp()` Get the banner BMP.
`java.util.List<MsiLocalizedResource>`	`getI18n()` return the file for optional language resource locations
`Msi.InstallScope`	`getInstallScope()` Get the install scope.
`java.util.List<com.inet.gradle.setup.msi.MsiLanguages>`	`getLanguages()` Get the languages that the setup should be support.
`java.util.List<Launch4j>`	`getLaunch4js()` Returns the registered services.
`double`	`getMinOS()` Get the minimum OS version.
`int`	`getMultiInstanceCount()` Get the count of possible multiple instances.
`java.net.URL`	`getMultiInstanceScript()` Get the URL to a vbscript that set the instance name.
`java.util.List<java.lang.String>`	`getPreGUI()` Returns the preGUI scripts.
`com.inet.gradle.setup.msi.SignTool`	`getSignTool()` Get the SignTool configuration if set
`java.net.URL`	`getWxsTemplate()` Get a URL to a *.wxs file for the WIX Toolset
`void`	`i18n(java.lang.Object localization)` add a localized resource to the project.
`boolean`	`isRunAfterOptional()` Returns if the runAfter is optional
`void`	`launch4j(groovy.lang.Closure<Launch4j> closue)` Register a lauch4j configuration.
`void`	`preGUI(java.lang.Object script)` Add a vbscript or jscript that should be executed before the GUI is displayed.
`protected void`	`processFiles(org.gradle.api.internal.file.CopyActionProcessingStreamAction action)` Handle all files of this task.
`void`	`setArch(java.lang.String arch)` Set the architecture of the setup.
`void`	`setBannerBmp(java.lang.Object bannerBmp)` Set a file with a banner BMP.
`void`	`setDialogBmp(java.lang.Object dialogBmp)` Set a file with the dialog BMP.
`void`	`setInstallScope(Msi.InstallScope installScope)` Set the install scope.
`void`	`setLanguages(java.lang.Object languages)` Set a list of languages for the setup GUI.
`void`	`setMinOS(double minVersion)` Set the minimum OS version.
`void`	`setMultiInstanceCount(int instanceCount)` Set the count of possible multiple instances.
`void`	`setMultiInstanceScript(java.lang.Object multiInstanceScript)` Set a vbscript that can change the product name, instance id and other things on a multi instance installation.
`void`	`setPreGUI(java.lang.Object script)` Set a vbscript or jscript that should be executed before the GUI is displayed.
`void`	`setRunAfterIsOptional(boolean runAfterIsOptional)` Set that the runAfter is optional
`void`	`setWxsTemplate(java.lang.Object wxsTemplate)` Set an optional *.wxs file as template for building the final file with the settings of the gradle task.
`void`	`signTool(groovy.lang.Closure<com.inet.gradle.setup.msi.SignTool> closue)` Set the needed information for signing the setup.

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractSetupTask
getPostinst, getPostrm, getPreinst, getPrerm, getSetupBuilder, setPostinst, setPostrm, setPreinst, setPrerm

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractTask
action, copyTo, getAbstractSetupBuilder, getClassifier, getDescription, getExtension, getFileLookup, getFileResolver, getFileSystem, getInstantiator, getRootSpec, getSetupFile, getSetupSource, getSource, getVersion, setClassifier, setExtension, setVersion

Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActionClassLoaders, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inet.gradle.setup.abstracts.SetupSources
eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDuplicatesStrategy, getExcludes, getFileMode, getFilteringCharset, getIncludeEmptyDirs, getIncludes, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

- Constructor Detail
  - Msi
```
public Msi()
```
    Create a new instance.
- Method Detail
  - build
```
public void build()
```
    The platform depending build.
    
    Specified by:
    
    build in class AbstractTask
  - processFiles
```
protected void processFiles(org.gradle.api.internal.file.CopyActionProcessingStreamAction action)
```
    Handle all files of this task.
    
    Overrides:
    
    processFiles in class AbstractTask
    
    Parameters:
    
    action - the action that should be process for every file
  - getArch
```
public java.lang.String getArch()
```
    Get the architecture of the installer.
    
    Returns:
    
    the architecture
  - setArch
```
public void setArch(java.lang.String arch)
```
    Set the architecture of the setup. The default is x64. Possible values are:
    - x86
    - x64
    - ia64
    - x86-only - does not run on a 64 bit system
    Parameters:
    
    arch - the architecture
  - getBannerBmp
```
public java.io.File getBannerBmp()
```
    Get the file of the banner or null
    
    Returns:
    
    the file
  - setBannerBmp
```
public void setBannerBmp(java.lang.Object bannerBmp)
```
    Set a file with a banner BMP. The typical size is 493 x 58
    
    Parameters:
    
    bannerBmp - the file
  - getDialogBmp
```
public java.io.File getDialogBmp()
```
    Get the banner BMP.
    
    Returns:
    
    the BMP
  - setDialogBmp
```
public void setDialogBmp(java.lang.Object dialogBmp)
```
    Set a file with the dialog BMP. The typical size is 493 x 312
    
    Parameters:
    
    dialogBmp - the file
  - signTool
```
public void signTool(groovy.lang.Closure<com.inet.gradle.setup.msi.SignTool> closue)
```
    Set the needed information for signing the setup.
    
    Parameters:
    
    closue - the data for signing
  - getSignTool
```
public com.inet.gradle.setup.msi.SignTool getSignTool()
```
    Get the SignTool configuration if set
    
    Returns:
    
    the settings or null
  - getWxsTemplate
```
public java.net.URL getWxsTemplate()
                            throws java.net.MalformedURLException
```
    Get a URL to a *.wxs file for the WIX Toolset
    
    Returns:
    
    the template
    
    Throws:
    
    java.net.MalformedURLException - if any error occur
  - setWxsTemplate
```
public void setWxsTemplate(java.lang.Object wxsTemplate)
```
    Set an optional *.wxs file as template for building the final file with the settings of the gradle task. This template give you the option to set things that are not available via the gradle task.
    
    Parameters:
    
    wxsTemplate - the file location
  - getLanguages
```
public java.util.List<com.inet.gradle.setup.msi.MsiLanguages> getLanguages()
```
    Get the languages that the setup should be support. The list must at minimum one element.
    
    Returns:
    
    a list of languages
  - setLanguages
```
public void setLanguages(java.lang.Object languages)
```
    Set a list of languages for the setup GUI. For example "en-us". By default all available languages will be added to the setup. This can need some time on creation.
    
    Parameters:
    
    languages - the languages
  - getMinOS
```
public double getMinOS()
```
    Get the minimum OS version.
    
    Returns:
    
    the version
  - setMinOS
```
public void setMinOS(double minVersion)
```
    Set the minimum OS version.
    - 10.0 - Windows 10
    - 10.0 - Windows Server 2016
    - 6.3 - Windows 8.1
    - 6.3 - Windows Server 2012 R2
    - 6.2 - Windows 8
    - 6.2 - Windows Server 2012
    - 6.1 - Windows 7
    - 6.1 - Windows Server 2008 R2
    - 6.0 - Windows Server 2008
    - 6.0 - Windows Vista
    - 5.2 - Windows Server 2003 R2
    - 5.2 - Windows Server 2003
    - 5.2 - Windows XP 64-Bit Edition
    - 5.1 - Windows XP
    - 5.0 - Windows 2000
    Parameters:
    
    minVersion - the version
  - launch4j
```
public void launch4j(groovy.lang.Closure<Launch4j> closue)
```
    Register a lauch4j configuration.
    
    Parameters:
    
    closue - the closure of the launch4j definition
  - getLaunch4js
```
public java.util.List<Launch4j> getLaunch4js()
```
    Returns the registered services.
    
    Returns:
    
    the registered services
  - getMultiInstanceCount
```
public int getMultiInstanceCount()
```
    Get the count of possible multiple instances.
    
    Returns:
    
    instance count
  - setMultiInstanceCount
```
public void setMultiInstanceCount(int instanceCount)
```
    Set the count of possible multiple instances. The default is 1. A value lesser or equals 1 result in a single instance setup.
    
    Parameters:
    
    instanceCount - the current instance count
  - getMultiInstanceScript
```
public java.net.URL getMultiInstanceScript()
                                    throws java.net.MalformedURLException
```
    Get the URL to a vbscript that set the instance name.
    
    Returns:
    
    the URL
    
    Throws:
    
    java.net.MalformedURLException - if any error occur
  - setMultiInstanceScript
```
public void setMultiInstanceScript(java.lang.Object multiInstanceScript)
```
    Set a vbscript that can change the product name, instance id and other things on a multi instance installation.
    
    Parameters:
    
    multiInstanceScript - the script
  - getInstallScope
```
public Msi.InstallScope getInstallScope()
```
    Get the install scope. Never null.
    
    Returns:
    
    the scope
  - setInstallScope
```
public void setInstallScope(Msi.InstallScope installScope)
```
    Set the install scope. Possible values are perUser and perMachine. If not set then it is perMachine. A perUser installer has no elevated rights and can not installed to program files.
    
    Parameters:
    
    installScope - the new scope
  - getPreGUI
```
public java.util.List<java.lang.String> getPreGUI()
```
    Returns the preGUI scripts.
    
    Returns:
    
    the scripts
  - setPreGUI
```
public void setPreGUI(java.lang.Object script)
```
    Set a vbscript or jscript that should be executed before the GUI is displayed. This can be used for setting a default install directory. This action has no elevated rights.
    
    Parameters:
    
    script - list or single script
  - preGUI
```
public void preGUI(java.lang.Object script)
```
    Add a vbscript or jscript that should be executed before the GUI is displayed. This can be used for setting a default install directory. This action has no elevated rights.
    
    Parameters:
    
    script - the content for the entry
  - isRunAfterOptional
```
public boolean isRunAfterOptional()
```
    Returns if the runAfter is optional
    
    Returns:
    
    the runAfterIsOptional
  - setRunAfterIsOptional
```
public void setRunAfterIsOptional(boolean runAfterIsOptional)
```
    Set that the runAfter is optional
    
    Parameters:
    
    runAfterIsOptional - the runAfterIsOptional to set
  - i18n
```
public void i18n(java.lang.Object localization)
```
    add a localized resource to the project. The files have to bi in the property file format and will be converted to wixLocalization files
    
    Parameters:
    
    localization - the localization object
  - getI18n
```
public java.util.List<MsiLocalizedResource> getI18n()
```
    return the file for optional language resource locations
    
    Returns:
    
    the localized resources

Class Msi

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractSetupTask

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Methods inherited from interface com.inet.gradle.setup.abstracts.SetupSources

Constructor Detail

Msi

Method Detail

build

processFiles

getArch

setArch

getBannerBmp

setBannerBmp

getDialogBmp

setDialogBmp

signTool

getSignTool

getWxsTemplate

setWxsTemplate

getLanguages

setLanguages

getMinOS

setMinOS

launch4j

getLaunch4js

getMultiInstanceCount

setMultiInstanceCount

getMultiInstanceScript

setMultiInstanceScript

getInstallScope

setInstallScope

getPreGUI

setPreGUI

preGUI

isRunAfterOptional

setRunAfterIsOptional

i18n

getI18n