使用须知
- 本章节开放的类,请遵循同一个类实例在单一线程中使用的原则,请勿将同一个类实例在不同的线程中使用。
- 请注意输入为STL容器或webjson参数的函数,应基于性能和实际业务需求限制容器长度,以防止可能出现的内存问题。
- 传入接口内的json相关内容中请勿包含注释,否则会引起解析失败。
- 若json相关内容中单个object存在key值相同键值对,接口将默认保留最后一组键值对作为解析结果。
- C++接口中存在由编译器生成的接口,例如默认构造函数,默认析构函数以及赋值构造函数等接口,不在本文作详细说明。
- 部分接口以及数据结构是由protobuf生成。需注意protobuf会自动生成protobuf内部自定义的类以及数据结构,请用户不要使用protobuf内部自定义的类和数据结构。
接口管理规范
- 标记有宏 SDK_AVAILABLE_FOR_OUT 的接口,表示对用户开放。
- 标记有宏 SDK_AVAILABLE_FOR_IN 的接口,表示内部使用,请用户不要使用。
- 标记有宏 SDK_UNAVAILABLE_FOR_OTHER 的接口,表示为隐藏,用户无法使用。
- 标记有宏 SDK_DEPRECATED_FOR 的接口,表示在未来版本会弃用,建议使用替代接口。