ChangeSummaryManager Class

Beta

Class to extract Change Summaries for a briefcase.

See also:

Methods

Name Description
attachChangeCache(iModel: IModelDb): void Static Attaches the Change Cache file to the specified iModel if it hasn't been attached yet.  
buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: object, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string Static Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.  
detachChangeCache(iModel: IModelDb): void Static Detaches the Change Cache file from the specified iModel.  
downloadChangeSets(requestContext: AuthorizedClientRequestContext, ctx: ChangeSummaryExtractContext, startChangeSetId: GuidString, endChangeSetId: GuidString): Promise<ChangeSet[]> Static    
extractChangeSummaries(requestContext: AuthorizedClientRequestContext, iModel: IModelDb, options?: ChangeSummaryExtractOptions): Promise<Id64String[]> Static Extracts change summaries from the specified iModel.  
getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[] Static Retrieves the names of the properties whose values have changed for the given instance change

See also Change Summary Overview
 
isChangeCacheAttached(iModel: IModelDb): boolean Static Determines whether the Change Cache file is attached to the specified iModel or not  
queryChangeSummary(iModel: IModelDb, changeSummaryId: Id64String): ChangeSummary Static Queries the ChangeSummary for the specified change summary id

See also
- ECDbChange.ChangeSummary ECClass in the ECDbChange ECSchema
- Change Summary Overview
 
queryInstanceChange(iModel: IModelDb, instanceChangeId: Id64String): InstanceChange Static Queries the InstanceChange for the specified instance change id.  

Defined in

Last Updated: 20 September, 2019