BrightSign Object Reference Manual (FW 5.1) User Manual

Page 192

Advertising
background image

184

GetFile(section As String, index As Integer) As roAssociativeArray: Returns an
roAssociativeArray object for the file in the specified section and at the specified index. This method returns Invalid
if the read operation fails.

GetName() As String: Returns the name supplied for the sync spec in the <sync> XML element.

EqualTo(other As roSyncSpec) As Boolean: Compares the contents of the roSyncSpec object with
another roSyncSpec object. This method compares the parsed contents of each sync spec rather than the XML
files themselves.

VerifySignature(signature as String, obfuscated_passphrase as String) As Boolean: De-
obfuscates the passphrase and uses it to verify the signature of the sync spec. This method returns True upon
success and False upon failure.

FilterFiles(section As String, criteria As roAssociativeArray) As roSyncSpec: Returns a
new roSyncSpec object that is a copy of the existing object, except that the specified section is filtered using the
specified criteria. The criteria are matched against the file metadata. Multiple criteria can be specified in the passed
associative array, and all criteria must be met for a file to be returned with the new roSyncSpec.

Example: The following function will yield an roSyncSpec object with a "download" section that has been filtered so
that only files of the group "scripts" will remain.

filtered_spec = spec.FilterFiles("download", { group: "scripts" })

FilesEqualTo(a As Object) As Boolean

GetAssets(a As String) As Object

Advertising