Specifies whether to retrieve refreshed data from the Content Engine server for
updating an object's property cache when the object is explicitly saved or is
committed to the persistent store as part of a batch.
Note:Note that you cannot refresh an object's property cache until the object
has been created on the Content Engine server. Attempting to do so causes an
API_SAVE_BEFORE_REFRESH exception to be thrown.
Namespace:
FileNet.Api.ConstantsUse this constant when calling methods that have a refresh parameter, such as Save and CreateUpdatingBatchInstance. Depending on the parameters of the method being called, you can either refresh all of the object's properties or, by specifying a property filter, refresh a subset of the object's properties.

Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Enumeration RefreshMode |
C# |
---|
public enum RefreshMode |
Visual C++ |
---|
public enum class RefreshMode |
JavaScript |
---|
FileNet.Api.Constants.RefreshMode = function(); FileNet.Api.Constants.RefreshMode.createEnum('FileNet.Api.Constants.RefreshMode', false); |
Members
Type | Member name | Description |
---|---|---|
NO_REFRESH |
Specifies that upon saving or committing the object, its property cache is not
refreshed with updated data from the Content Engine server.
| |
REFRESH |
Specifies that upon saving or committing the object, its property cache is
refreshed with updated data from the Content Engine server.
Specifying REFRESH synchronizes the object's properties with those in the persistent store. |