Deprecated and Removed Members: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) |
Kate Racaza (talk | contribs) |
||
| Line 8: | Line 8: | ||
==Changes since Synthesis API Version 10== | ==Changes since Synthesis API Version 10== | ||
*'''<span style="color:#FCF8F8; background-color:#1D572F"> Major </span>''' The [[Repository Class|Repository class]] has been restructured. All of its members are now organized into fields named after the object type they apply to. For example, the <code>Repository.GetAllModels()</code> method, which returns a cModel object, has been renamed to <code>Repository.Model.GetAllModels()</code>; similarly, the <code>Repository.ImportBlockSimXMLFile</code> method has been renamed to <code>Repository.BlockSim.ImportBlockSimXMLFile</code>, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API. | |||
'''<span style="color:#FCF8F8; background-color:#1D572F"> Major </span>''' | |||
* The [[Repository.Model.GetAllModelsInfo|Model.GetAllModelsInfo()]] method is deprecated. Please use the [[Repository.Model.GetAllModels|Model.GetAllModels()]] method going forward. | |||
* Obsolete properties in the [[CAction Class|cAction class]] have been removed. | |||
<ul> | |||
{| {{APITableDeprecated}} | {|{{APITableDeprecated}} | ||
|- | |- | ||
| style="width: 200px;"|AppAndRevBy||Removed | | style="width: 200px;"|AppAndRevBy||Removed | ||
| Line 40: | Line 39: | ||
|- | |- | ||
|StatusFlag||Removed | |StatusFlag||Removed | ||
|} | |}</ul> | ||
*We've deprecated some properties in the [[CScheduledTask_Class|cScheduledTask class]]. | |||
<ul> | |||
{| {{APITableDeprecated}} | {| {{APITableDeprecated}} | ||
|- | |- | ||
| Line 54: | Line 52: | ||
|- | |- | ||
|TaskFreqValueVariableIDOrig||Deprecated | |TaskFreqValueVariableIDOrig||Deprecated | ||
|} | |}</ul> | ||
Revision as of 18:23, 17 September 2015
 |
This page provides a summary of what has been changed, removed and deprecated in the Synthesis API since its earlier version. The status of an object member may be any of the following:
- Changed - The syntax of the member has changed.
- Deprecated - The member is obsolete and may be removed in future versions of the API. Do not use it in new applications.
- Removed - The member has been removed from the object model.
Changes since Synthesis API Version 10
- Major The Repository class has been restructured. All of its members are now organized into fields named after the object type they apply to. For example, the
Repository.GetAllModels()method, which returns a cModel object, has been renamed toRepository.Model.GetAllModels(); similarly, theRepository.ImportBlockSimXMLFilemethod has been renamed toRepository.BlockSim.ImportBlockSimXMLFile, etc. The previous versions of the methods still exist so your code is not broken, but they are deprecated and may be removed in future versions of the API.
- The Model.GetAllModelsInfo() method is deprecated. Please use the Model.GetAllModels() method going forward.
- Obsolete properties in the cAction class have been removed.
| Name | Status |
|---|---|
| AppAndRevBy | Removed |
| AppDate | Removed |
| AppUserID | Removed |
| CompDate | Removed |
| DueDate | Removed |
| Duration | Removed |
| EstCost | Removed |
| PersonResp | Removed |
| RespUserID | Removed |
| ShortDsc | Removed |
| StartDate | Removed |
| StatusFlag | Removed |
- We've deprecated some properties in the cScheduledTask class.
| Name | Status |
|---|---|
| TaskFrequencyIDOrig | Deprecated |
| TaskFrequencyUnitIDOrig | Deprecated |
| TaskFrequencyValueOrig | Deprecated |
| TaskFreqValueVariableIDOrig | Deprecated |