Publishing methods
PublishingGetStorage
Get Publishing Storage
Return the storage location on MFT FS server where file published from external application will be stored.
FTHPublishStorageData
PublishingGetStorage(Guid sessionID, string externalMajorLocationID, string externalMajorLocationName, string externalMinorLocationID, string externalMinorLocationName, string externalFileID)
This method accepts three parameters:
- Location Major: General identification of external system (such as Sharepoint site url).
- Location Minor: Detailed identification of file library
- External File ID
If ExternalFileID is found in MFT FS file system publishing area, this method will return MFT FS parent folder ID and MFT FS file ID.
If not then the method will return only parent folder ID for uploading the file and returned MFT FS file ID will be null.
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
externalMajorLocationID | For Sharepoint Integration: Sharepoint site Url |
externalMajorLocationName | For Sharepoint Integration: Sharepoint site name |
externalMinorLocationID | For Sharepoint Integration: Sharepoint library ID |
externalMinorLocationName | For Sharepoint Integration: Sharepoint library name |
externalFileID | For Sharepoint Integration: Sharepoint file ID |
CreateFileExternalSourceMapping
Binds Id of the file in MFT FS server with external IDs of 2 levels to identify the target file on MFT FS site for overwrite operations when the source file in external system is overwritten.
void
CreateFileExternalSourceMapping (Guid sessionID, int thruFileID, string externalMajorLocationID, string externalMajorLocationName, string externalMinorLocationID, string externalMinorLocationName, string externalFileID, string externalFileName)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
thruFileID | MFT FS File |
externalMajorLocationID | For Sharepoint Integration: Sharepoint site Url |
externalMajorLocationName | Name of Sharepoint Application |
externalMinorLocationID | For Sharepoint Integration: Sharepoint library ID |
externalMinorLocationName | Name of Document Library |
externalFileID | For Sharepoint Integration: Sharepoint file ID |
externalFileName | Sharepoint file name |
PublishingGetFileInfo
Retrieve information on the publishing status of the file
FTHPublishFileData PublishingGetFileInfo (Guid sessionID, int fileID)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
fileID | ID of the file in MFT FS database |
PublishingCreateRequest
Create request to publish the file
FTHPublishRequestData
PublishingCreateRequest (Guid sessionID, int publishLinkID, int publishCollectionID, bool useDefaultLinkInfo, string overWriteLinkText, string overWriteDescription, string requestText )
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
publishLinkID | ID of the file in MFT FS server file system that is requested to be published. In the future could be used for a folder publishing. |
publishCollectionID | Collection that should contain the published file |
useDefaultLinkInfo | If set, use default information for the published link: Name, Description |
overWriteLinkText | Text to overwrite default link name |
overWriteDescription | Text to overwrite default Description |
requestText | Text of request. |
PublishingDeletePendingRequest
Delete pending publishing request
Void PublishingDeletePendingRequest (Guid sessionID, int publishingRequestID)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
publishingRequestID | ID of the pending publishing request |
PublishingSavePendingRequest
Saves changed information to a pending publishing request.
void PublishingSavePendingRequest (Guid sessionID, FTHPublishRequestData requestData)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user |
requestData | Data for the pending request that will be saved |
PublishingGetCollections
Method returns collection list which is used in collection drop-down in new request form
FTHPublishCollectionData[]
PublishingGetCollections(Guid sessionID, int publishLinkID)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of Open functions |
publishLinkID | ID of the collection link object |
PublishingTagDictionaryGetItems
Retrieve tags from publishing Tag dictionary
FTHPublishTagData[]
PublishingTagDictionaryGetItems(Guid sessionID)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user returned by one of the Open functions.` |
PublishingTagDictionaryAddItems
Add tags to dictionary
void PublishingTagDictionaryAddItems(Guid sessionID, string commadDelimitedTagList)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user returned by one of the Open functions. |
commadDelimitedTagList | New tags (Duplicates and existing tags are silently ignored) |
PublishingTagDictionaryRemoveItems
Remove items from publishing Tag dictionary
void PublishingTagDictionaryRemoveItems(Guid sessionID, string commadDelimitedTagList)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user returned by one of the Open functions. |
commadDelimitedTagList | Tags to remove (Non existing tags are silently ignored). |
PublishingSaveLink
Use this method to update the default link, description and tags. Link is a virtual entity that holds file metadata and is pointed to by ‘Collection Links’ which are links to the file that exist in the context of a collection.
void PublishingSaveLink(Guid sessionID, FTHPublishLinkData publishLinkData)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user returned by one of the Open functions. |
publishLinkData | Data for the publishing file link |
PublishingDeleteCollectionLink
Use this method to delete the collection link
void PublishingDeleteCollectionLink(Guid sessionID, int publishCollectionLinkID)
| Parameter Name | Description |
|---|---|
sessionID | Session ID for the current user returned by one of the Open functions. |
publishCollectionLinkID | ID of the publishing collection link |
PublishingSaveCollectionLink
Use this method to save the changed data for ‘collection link’ which is the file link existing in the context of collection
void
PublishingSaveCollectionLink (Guid sessionID, FTHPublishCollectionLinkData collectionLinkData)
| Parameter Name | Description |
|---|---|
sessionID | User session |
collectionLinkData | Collection data to save |
