跳转至

Class qqmusic::details::Api

ClassList > qqmusic > details > Api

Api类, 简化请求报文组装和返回报文解析过程

  • #include <api.h>

Public Functions

Type Name
Api (utils::Session & session, std::string module, std::string method, utils::Credential credential={}, nlohmann::json common={{}})
构造函数
qqmusic::Result< nlohmann::json > parse_response (utils::buffer && response)
将返回报文解析成Json结果, 必须是由Api类产生的请求产生的结果
qqmusic::Task< qqmusic::Result< RequestParam > > prepare_request (const nlohmann::json & params, bool verify=false)
使用给定的参数组装请求

Public Functions Documentation

function Api

构造函数 

inline qqmusic::details::Api::Api (
    utils::Session & session,
    std::string module,
    std::string method,
    utils::Credential credential={},
    nlohmann::json common={{}}
)

Parameters:

  • session session实例引用
  • module Api所属模块
  • method Api请求方法
  • credential 凭证, 默认为空
  • common 公共参数

Note:

credential的取舍优先级: 传入的参数 > session(全局默认) > 默认初始化credential

function parse_response

将返回报文解析成Json结果, 必须是由Api类产生的请求产生的结果 

qqmusic::Result< nlohmann::json > qqmusic::details::Api::parse_response (
    utils::buffer && response
)

function prepare_request

使用给定的参数组装请求 

qqmusic::Task< qqmusic::Result< RequestParam > > qqmusic::details::Api::prepare_request (
    const nlohmann::json & params,
    bool verify=false
)

Parameters:

  • params 请求体数据表单
  • verify 是否需要合法的Credential进行请求

Returns:

产生RequestParam打包的请求参数

The documentation for this class was generated from the following file include/qqmusic/details/api.h