AquaLogic Interaction Development Kit (IDK) 6.0.0 |

# 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
  The ID of the document to set refresh rate; cannot be negative.
refreshInterval
  The time interval specifying the refresh interval value and unit. The numeric component must be between 1 and 999, otherwise an `ArgumentException` will be thrown. Setting the `refreshInterval` to `TimeInterval.INFINITE` will cause the document to never be refreshed.
doNotRefreshProperties
  `True` if only the link to the document should be confirmed, and no document properties should 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 refresh interval must be between 1 and 999, otherwise an `ArgumentException` will be thrown.
Setting the `refreshInterval` to `TimeInterval.INFINITE` will set the document to never be 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 the operation resulted in an error on the portal.
SoapException | There was 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 and 999.
NullReferenceException | The TimeInterval or the unit component of the TimeInterval is `null`.

#### See Also

IDocumentManager Interface | Plumtree.Remote.PRC Namespace