requirements_list.rtf

AveDesk Installer :: Requirements Types

This file will give an overview of all the types that can be used in the Requirements-section of an AveDesk Installer XML file.

RequiredAveDeskVersion

This requirement can be used if a miminum version of AveDesk needs to be installed. The version should be in the Item-node's Text and must be in the Major.Minor format.

Example:
              <Item Type="RequiredAveDeskVersion">1.2</Item>

RequiredInstallerVersion

This requirement can be used if a miminum version of AveDesk's Installers needs to be installed. The version should be in the Item-node's Text and must be in the Major.Minor format.

NOTE: AveDesk 1.2's Installer version is 1.2 also.

Example:
              <Item Type="RequiredInstallerVersion">1.2</Item>

FileExists

This requirement can be used if a file (or multiple files) needs to exist.

Files are described with Directory/File nodes as childnodes of the Item-node, as used in the CopyInformation-section.

Example:
              <Item Type="FileExists">

                            <Directory BaseFolder="Desklets">

                                          <Directory Name="PidlShortcut">

                                                                      <File>pidlshortcut.dll</File>

                                                        </Directory>

                                          </Directory>

                            <OnError>

                                          <Message>

                                                        You will need PIDLShortcut for this.

                                          </Message>

                                          <DownloadableFile>

                                                        <URL>

                                                        http://mpj.tomaatnet.nl/PidlShortcut.aveinst

                                                        </URL>

                                          </DownloadableFile>

                            </OnError>

              </Item>

Not

This requirement can be used if you need a certain other requirement to be not met. In essence, it's a negation.

The Requirement that should not be met, is a Item-childnode of the "Not"-node.

Example:

              <Item Type="Not">

                            <Item Type="RequiredAveDeskVersion">1.1</Item>

              </Item>

AcceptText

This requirement can be used if you need the user to accept a question, user-agreement, or some other text. The user will get a MessageBox with the text and YES - NO buttons. If the user selects YES, then the requirement is met, otherwise it fails.

The text that will be shown in the MessageBox must be in the Item-node's Text.

Example:

              <Item Type="AcceptText">

                            You will install this desklet on your own risc!

                            Continue?

              </Item>

DeskletIsUsed

This requirement can be used if you need a certain desklet to be in use (is loaded). Often it is used together with the Not-requirement. The requirement will be met if the desklet is in use, otherwise it will fail.

The particular desklet should be described by its DLL, so the Directory/File-nodes are used.

Example:

              <Item Type="DeskletIsUsed">

                            <Directory BaseFolder="Desklets">

                                          <Directory Name="AveTunes">

                                                        <File>iTunesWidget.dll</File>

                                          </Directory>

                            </Directory>                                                                     

              </Item>

PackageIsInstalled

This requirement can be used if you need a certain package to be installed. The requirement will be met if the package is installed, otherwise it will fail. Often, you will use your own OnError block with a DownloadableFile/URL to the package.

The GUID of the package must be described in a GUID-childnode. It should be the Text of this GUID-childnode.

Example:

              <Item Type="PackageIsInstalled">

                            <GUID>E0289F6C-8F58-4752-9F39-022F36EC9D65</GUID>

                            <OnError>

                                          <Message>

                                                        You need PidlShortcut to be installed.

                                          </Message>

                                          <DownloadableFile>

                                                        <URL>

                                                        http://mpj.tomaatnet.nl/pidlshortcut.aveinst

                                                        </URL>
                                          </DownloadableFile>

                            </OnError>

              </Item>

RequiredDeskletVersion

This requirement can be used if you need a certain version of a desklet. The requirement will be met if the desklet is present AND if the version is equal-or-greaterthan the version.

The particular desklet should be described by its DLL, so the Directory/File-nodes are used.

The version to check for should be described in a Version-childnode, with the version as this Version-childnode's Text in the Major.Minor format.

Example:

              <Item Type="DeskletIsUsed">

                            <Version>2.6</Version>

                            <Directory BaseFolder="Desklets">

                                          <Directory Name="AveTunes">

                                                        <File>iTunesWidget.dll</File>

                                          </Directory>

                            </Directory>                                                                     

              </Item>

-------------------------------------------------------

(c) copyright Andreas Verhoeven 2005