Instructions

  • For the open classes described in this section, the same class instance is used in a single thread. Do not use the same class instance in different threads.
  • For functions whose inputs are STL containers or webjson parameters, the container lengths must be limited based on performance and actual service requirements to prevent potential memory issues.
  • The JSON content passed to APIs cannot contain comments. Otherwise, parsing fails.
  • If there are same key-value pairs of a single object in JSON, APIs retain the last key-value pair as the parsing result by default.
  • C++ APIs include APIs generated by compilers, such as default constructors, default destructors, and assignment constructors, which are not described in this document.
  • Some APIs and data structures are generated by protobuf. Note that protobuf automatically generates customized classes and data structures, which are not recommended for use.

API Management Specifications

  • APIs marked with macro SDK_AVAILABLE_FOR_OUT are open to users.
  • APIs marked with macro SDK_AVAILABLE_FOR_IN are for internal use only. Do not use them.
  • APIs marked with macro SDK_UNAVAILABLE_FOR_OTHER are hidden and cannot be used by users.
  • APIs marked with macro SDK_DEPRECATED_FOR will be deprecated in later versions. You are advised to use the replacement APIs.