IDocumentManager.SetRefreshRate Method

Sets the document refresh rate, which determines how often a document and its properties will get refreshed.

void SetRefreshRate(
   int documentID,
   TimeInterval refreshInterval,
   bool doNotRefreshProperties
);

Parameters

documentID: ID of the document to set refresh rate; cannot be negative.
refreshInterval: Time interval specifying the refresh interval value and unit. The numeric component must be between 1 to 999, otherwise an ArgumentException will be thrown. Setting the refreshInterval to TimeInterval.INFINITE will cause the document to never get refreshed.
doNotRefreshProperties: If set to true, only the link to the document will be confirmed, and no document properties will be refreshed, otherwise false.

Remarks

If the boolean value of doNotRefreshProperties is set to true, only the validity of the link to this document will be confirmed and no document properties will be refreshed.
The numeric component of the resfresh interval must be between 1 to 999, otherwise an ArgumentException will be thrown.
Setting the refreshInterval to TimeInterval.INFINITE will set the document to be never refreshed.
The default refresh rate for a document is set by the document Crawler.

Exceptions

Exception Type	Condition
PortalException	The document ID is invalid, or if the operation resulted in an error on the portal.
SoapException	There is a communication problem during the execution of the remote method call
ArgumentException	The documentID is negative, or the numeric component of the refreshInterval is not between 1 to 999.
NullReferenceException	TimeInterval or the unit component of the timeInterval is `null`.

IDocumentManager.SetRefreshRate Method

Parameters

Remarks

Exceptions

See Also