BrightSign Object Reference Manual (FW 5.1) - Manual (Page 141)

133
roBrightPackage
An roBrightPackage object represents a .zip file. The .zip file can include arbitrary content or can be installed on a storage
device to provide content and script updates (for example, to distribute updates via USB thumb drives).
Object Creation: The roBrightPackage object is created with a
filename parameter that specifies the name of the .zip file.
CreateObject("roBrightPackage", filename As String)
Interfaces: ifBrightPackage
The ifBrightPackage interface provides the following:
• Unpack(path As String) As Void: Extracts the zip file to the specified destination path. Any preexisting files
in the target directory will be deleted as part of this operation. Providing a destination path of "SD:/" will wipe all
preexisting files from the card and extract the .zip contents to the root folder.
• SetPassword(password As String) As Void: Provides the password specified when the .zip file was
created. roBrightPackage supports AES 128 and 256 bit encryption, as generated by WinZip.
• GetFailureReason() As String
• UnpackFile(a As String, b As String) As Boolean
Note: ifBrightPackage is a legacy interface. We recommend you use roAssetPool instead to achieve better
functionality.
Example:
package = CreateObject("roBrightPackage", "newfiles.zip")
package.SetPassword("test")
package.Unpack("SD:/")