GetRevisionFileAssociationsByIds Method
This method gets all files associations of a set of files by file ID. The returned files will point to the latest version within a revision.
Required Permissions
FileReadSyntax
public FileAssocArray[] GetRevisionFileAssociationsByIds(
System.long[] fileIds,
FileAssociationTypeEnum parentAssociationType,
System.bool parentRecurse,
FileAssociationTypeEnum childAssociationType,
System.bool childRecurse,
System.bool includeRelatedDocuments,
System.bool includeHidden,
System.bool releasedBiased
)Public Function GetRevisionFileAssociationsByIds( _
ByVal fileIds() As System.Long, _
ByVal parentAssociationType As FileAssociationTypeEnum, _
ByVal parentRecurse As System.Boolean, _
ByVal childAssociationType As FileAssociationTypeEnum, _
ByVal childRecurse As System.Boolean, _
ByVal includeRelatedDocuments As System.Boolean, _
ByVal includeHidden As System.Boolean, _
ByVal releasedBiased As System.Boolean _
) As FileAssocArray()Parameters
| Name | Description |
|---|---|
| fileIds | An array of file IDs. |
| 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. |
| 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. |
| releasedBiased | If true, the latest version in a released state will be returned, if available. If false, the latest version will be returned, regardless of lifecycle state. |
Return Value
An array of file associations.