ICustomRouter.OnSubmitFile method
Allows users to process and/or save documents that are sent or uploaded to a site where there content organizer is enabled.
Assembly: Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)
CustomRouterResult OnSubmitFile( EcmDocumentRoutingWeb contentOrganizerWeb, string recordSeries, string userName, Stream fileContent, RecordsRepositoryProperty[] properties, SPFolder finalFolder, ref string resultDetails )
Parameters
- contentOrganizerWeb
- Type: Microsoft.Office.RecordsManagement.RecordsRepository.EcmDocumentRoutingWeb
Web site to which the document is being added.
- recordSeries
- Type: System.String
Content type of the document.
- userName
- Type: System.String
Login name of the user creating the file.
- fileContent
- Type: System.IO.Stream
Content stream of the file being organized.
- properties
- Type: []
Metadata of the file being organized.
- finalFolder
- Type: Microsoft.SharePoint.SPFolder
Final location configured for the document being organized.
- resultDetails
- Type: System.String
Custom information that should be logged by the content organizer.
Return value
Type: Microsoft.Office.RecordsManagement.RecordsRepository.CustomRouterResultReturns CustomRouterResult.
This method is invoked when documents in the drop-off library are being organized. Before calling the custom router, the content organizer calculates the final location configured for the document by the rule manager. The custom router can either allow the content organizer to continue to save the document content to the predetermined location, or save the document if the contents or the final location of the file need to be modified.The EcmDocumentRouter class provides an API to save the document to the site depending on the versioning settings configured for the content organizer. To prevent unexpected failures, the custom router must not close the content stream that is being passed in.
Documents that are submitted from an external connection will be saved to the drop-off library so that the custom call out can be run for the document. When documents are submitted from an external connection, the properties of the source document are also saved to the Original Properties (Field Guid = "{126CD502-6801-4ae4-9F56-BFC3488C4743}") column in the drop-off library.
