Deprecated APIs
Code written for an older version of a ReportingCloud SDK can still use members and packages that are deprecated today. They still work, but they get no updates, or Text Control has announced that they will be removed. For each of them, the tables below give what takes over its job.
What Deprecated Means
- Still available. A deprecated member is still in the SDK, and a deprecated package can still be installed. Neither gets new features.
- Marked in the source or the registry. The PHP SDK marks deprecated members with a
@deprecatedtag. Packagist marks abandoned packages and names their successor, and the description of a deprecated NuGet package starts with "[Deprecated". - Not for new code. Use the replacement in new code, and change existing code when you work on it.
- The Web API. No endpoint of the Web API is deprecated. It accepts both an API key and Basic authentication with a user name and password, and Text Control recommends API keys; see Authentication.
PHP SDK
| Deprecated | Use instead | Deprecated since |
|---|---|---|
The options username and password of the ReportingCloud constructor | The option api_key | 3.0 |
setUsername and setPassword | setApiKey | 3.0 |
getUsername and getPassword | getApiKey | 3.0 |
The change log of version 1.9.0, of October 2018, already called authentication with a user name and password deprecated, when the demos and tests of the SDK switched to API keys. Version 3.0 added the @deprecated tags, and its release notes announced the removal of the members in the next major version. Version 4.0 still contains them. An API key authenticates the same requests; API Keys shows how to create one, and PHP lists the options of the constructor.
Packages
| Deprecated | Use instead | Replacement released |
|---|---|---|
textcontrol/txtextcontrol-reportingcloud on Packagist, abandoned | textcontrol/textcontrol-reportingcloud | September 2023 |
textcontrol/txtextcontrol-reportingcloud-laminas-module on Packagist, abandoned | textcontrol/textcontrol-laminas-reportingcloud | September 2023 |
TXTextControl.ReportingCloud.Core on NuGet, described as deprecated | TXTextControl.ReportingCloud | November 2018 |
- The former PHP packages. The new packages use the namespace
TextControl\ReportingCloudinstead ofTxTextControl\ReportingCloud, so theusestatements change with the package; Breaking Changes has the steps. - The .NET Core package.
TXTextControl.ReportingCloudcontains the builds for .NET Framework, .NET Core and .NET Standard since version 1.200.500. .NET describes the package.
Removed Classes
These classes of the PHP SDK are no longer deprecated but gone. Code that still uses them fails after the update.
| Removed | Use instead | Removed in |
|---|---|---|
Stdlib\StringUtils | The string functions of PHP | 4.0.0 |
StatusCode, constants for HTTP status codes | The package ctw/ctw-http, which the SDK installs | 3.0 |
.NET, Java and Ruby SDKs
The .NET, Java and Ruby SDKs mark no member as obsolete or deprecated. The Java and Ruby SDKs authenticate with a user name and password only; the .NET SDK takes an API key as well. SDKs compares them.