GetFileAssociationLitesByIds Method
This method gets all files associations of a set of files by file Id. The resulting objects will contain file IDs only instead of full File objects.
Required Permissions
FileReadSyntax
public FileAssocLite[] GetFileAssociationLitesByIds(
System.long[] fileIds,
FileAssocAlg associationAlgorithm,
FileAssociationTypeEnum parentAssociationType,
System.bool parentRecurse,
FileAssociationTypeEnum childAssociationType,
System.bool childRecurse,
System.bool includeLibraryFiles,
System.bool includeRelatedDocuments,
System.bool includeHidden
)Public Function GetFileAssociationLitesByIds( _
ByVal fileIds() As System.Long, _
ByVal associationAlgorithm As FileAssocAlg, _
ByVal parentAssociationType As FileAssociationTypeEnum, _
ByVal parentRecurse As System.Boolean, _
ByVal childAssociationType As FileAssociationTypeEnum, _
ByVal childRecurse As System.Boolean, _
ByVal includeLibraryFiles As System.Boolean, _
ByVal includeRelatedDocuments As System.Boolean, _
ByVal includeHidden As System.Boolean _
) As FileAssocLite()Parameters
| Name | Description |
|---|---|
| fileIds | An array of file Ids in the Vault. |
| associationAlgorithm | The algorithm to use for traversing the file associtation tree. |
| parentAssociationType | The types of parents to get. |
| parentRecurse | If true, all levels of parents will be returned. If false, only the direct parents will be returned. |
| childAssociationType | The types of children to get. |
| childRecurse | If true, all levels of parents will be returned. If false, only the direct parents will be returned. |
| includeLibraryFiles | If false, files inside of library folders will be excluded. If true, files in library files will be included in the results. |
| includeRelatedDocuments | If true, parent design documents are returned for all returned files. If false, no additional files will be added to the return set. |
| includeHidden | If true, files marked as hidden will show up in the search. Otherwise hidden files will be excluded. |
Return Value
An array of lightweight objects representing every association found.