2.10.2 Publishing Methods

2.10.2.1 PublishingGetStorage

Get Publishing Storage
Return the storage location on Thru 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 3 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 Thru file system publishing area, this method will return Thru parent folder ID and Thru file ID.
If not than the method will return only parent folder ID for uploading the file and returned Thru 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

2.10.2.2 CreateFileExternalSourceMapping

CreateFileExternalSourceMapping
Binds Id of the file in Thru server with external IDs of 2 levels to identify the target file on Thru 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

Thru 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

2.10.2.3 PublishingGetFileInfo

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 Thru database

2.10.2.4 PublishingCreateRequest

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 Thru 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.

2.10.2.5 PublishingDeletePendingRequest

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

2.10.2.6 PublishingSavePendingRequest

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

2.10.2.7 PublishingGetCollections

PublishingGetCollections
Method returns collection list which is used in collection dropdown 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

2.10.2.8 PublishingTagDictionaryGetItems

PublishingTagDictionaryGetItems
Retrieve tags from publishing Tag dictionary

FTHPublishTagData[]
PublishingTagDictionaryGetItems(Guid sessionID)

sessionID

Session ID for the current user returned by one of the Open functions.

2.10.2.9 PublishingTagDictionaryAddItems

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)

2.10.2.10 PublishingTagDictionaryRemoveItems

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).

2.10.2.11 PublishingSaveLink

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

2.10.2.12 PublishingDeleteCollectionLink

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

2.10.2.13 PublishingSaveCollectionLink

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