How to create event handler for vault file download, add-in

[COLINBRUSCHI]

Hi All,

I've written an add-in to get out-of-date files from Vault (basic client). If the file has been locally modified, the acquire code wont overwrite the local copy. From what I can gather this behaviour can be changed by setting the PreFileAcquireEventArgs enum to "OK".

The SDK documentation gives the class: AcquireFilesSettings.AcquireFileExtensibilityOptions.PreFileAcquireEventArgs Class

and states: 

The result of the PreFileAcquireEvent. This can be set to specify how the acquire of this file should continue.

How does one handle the preacquire event?

The code to acquire as follows:

' Get settings 
 Dim oSettings As VDF.Vault.Settings.AcquireFilesSettings = New VDF.Vault.Settings.AcquireFilesSettings(oConnection)

'get 
oSettings.DefaultAcquisitionOption = VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download

oSettings.AddEntityToAcquire(oFileIteration)

'set the path to the working folder
        oSettings.LocalPath = fldrPath 

 oConnection.FileManager.AcquireFiles(oSettings)

[bradeneuropeArthur]

you have pre and post events:

AddHandler DocumentService.CheckoutFileEvents.Pre, AddressOf CheckouFileCheckPre

AddHandler DocumentService.CheckoutFileEvents.Post, AddressOf CheckinFileCheckPost

with these handlers:

Private Sub CheckinFileCheckPre(ByVal sender As Object, ByVal e As CheckinFileCommandEventArgs)
'Code
end sub

Private Sub CheckinFileCheckPost(ByVal sender As Object, ByVal e As CheckinFileCommandEventArgs)
'Code
end sub

[COLINBRUSCHI]

Thanks, I'm still a bit confused though.

If the event is handled by: 

AddHandler DocumentService.DownloadFileEvents.Pre, AddressOf preAcquire

How do I access the prefileacquireeventargs, as I guessed in below code:

Private Sub preAcquire(ByVal sender As Object, ByVal e As AcquireFilesSettings.AcquireFileExtensibilityOptions.PreFileAcquireEventArgs)

        e.PreFileAcquisitionResult = AcquireFilesSettings.PreFileAcquisitionResult.OK

    End Sub

This obviously throws an exception since the type of e doesnt match the downloadfileevents handler

[bradeneuropeArthur]

handler looks like this:

  Private Sub preAcquire(sender As Object, e As DownloadFileCommandEventArgs)

        End Sub

[COLINBRUSCHI]

How do you set the PreFileAcquireEventArgs from downloadfilecommandeventargs?

Only the following are accessible

[bradeneuropeArthur]

with:

 Private Sub preAcquire(sender As Object, e As DownloadFileCommandEventArgs)
            
            e.FileIds….
        End Sub

[COLINBRUSCHI]

Sorry, still somewhat lost.

I've added the addhandler line to my download file sub, this should create the link to the handler just before the file is acquired, however the event handler code doesnt run.

' Get settings 
        Dim oSettings As VDF.Vault.Settings.AcquireFilesSettings = New VDF.Vault.Settings.AcquireFilesSettings(oConnection)

        'get 
        oSettings.DefaultAcquisitionOption = VDF.Vault.Settings.AcquireFilesSettings.AcquisitionOption.Download

        oSettings.AddEntityToAcquire(oFileIteration)

        'set the path to the working folder
        oSettings.LocalPath = fldrPath 'connection.WorkingFoldersManager.GetWorkingFolder(oFileIteration)

        AddHandler DocumentService.DownloadFileEvents.Pre, AddressOf preAcquire

        'Do the download
        oConnection.FileManager.AcquireFiles(oSettings)

Do i use the fileIds in a getfilesbyIds type statement? How do I then access the PreFileAcquireEventArgs property?

[chandra.shekar.g]

@COLINBRUSCHI,

Hoping that below youtube link may be helpful.

https://www.youtube.com/watch?v=n9aTyhHjtJk

Thanks and regards,

[COLINBRUSCHI]

It appears you can't monitor events with vault basic...

From SDK documentation:

Availability
This feature is not available in base Vault.  Vault Workgroup, Vault Collaboration or Vault Professional is required.

[COLINBRUSCHI]

Well the solution wasn't to use an event, it was to configure the following option to force an overwrite:

oSettings.OptionsResolution.OverwriteOption = AcquireFilesSettings.AcquireFileResolutionOptions.OverwriteOptions.ForceOverwriteAll