CheckinFile

EventNames:

  • CheckinFile_Restrictions

  • CheckinFile_Pre

  • CheckinFile_Post

Parameters

Type

Name

Description

File

file

The file which is / was checked in.

Restrictions and Pre:
In Restrictions and Pre you have the future data set on this object like _NewName, _NewComment, _NewModDate, _NewClassification, _NewCheckedOut and _NewHidden.

Post:
In POST you can retrieve the information from previous events by using the properties _OldName, _OldComment, _OldModDate, _OldClassification, _OldCheckedOut and _OldHidden.

File[]

dependencies

The file dependencies what this new checked-in file has.

File[]

attachments

The attachments what this new checked-in file has.

FileBomRow[]

fileBom

The Bill of Materials of the checked-in file.
For Inventor files with multiple Model States only the BOM data of the Master model state is available.

bool

successful

Post:
The information whether the Web Service call was successful or not is only available in Post events.

Unexpected Behaviour

CheckinFile event is not raised when a file is added to Vault for the first time. Instead the AddFile event is raised.

Examples:
CheckinFile_Restrictions:

Register-VaultEvent -EventName CheckinFile_Restrictions -Action 'RestrictCheckinFile'
function RestrictCheckinFile($file, $dependencies, $attachments, $fileBom) {
	#Write event code here
}

CheckinFile_Pre:

Register-VaultEvent -EventName CheckinFile_Pre -Action 'PreCheckinFile'
function PreCheckinFile($file, $dependencies, $attachments, $fileBom) {
	#Write event code here
}

CheckinFile_Post:

Register-VaultEvent -EventName CheckinFile_Post -Action 'PostCheckinFile'
function PostCheckinFile($file, $dependencies, $attachments, $fileBom, $successful) {
	#Write event code here
}