HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_WebAPI Class Reference

#include <NET_WebAPI.h>

Public Types

using WebMap = UT_ArrayStringMap< UT_StringHolder >
 
using KWargs = UT_VariantMap
 

Static Public Member Functions

static UT_StringHolder decodeUri (const UT_StringView uri)
 
static UT_StringHolder encodeUri (const UT_StringView uri)
 
template<typename... Args>
static NET_HTTPResponse call (const UT_Url &api_url, const char *api_function, Args &&...args)
 
template<typename... Args>
static NET_HTTPResponse call (const UT_Url &api_url, const NET_WebMap &headers, const char *api_function, Args &&...args)
 
template<typename... Args>
static NET_HTTPResponse call (NET_NetSession &session, const UT_Url &api_url, const char *api_function, Args &&...args)
 
template<typename... Args>
static NET_WebAPIResponse call (NET_WebSocketSPtr ws, std::chrono::milliseconds timeout, const char *api_function, Args &&...args)
 
template<typename... Args>
static NET_Future
< NET_WebAPIResponse
callAsync (NET_WebSocketSPtr ws, const char *api_function, Args &&...args)
 
template<typename... Args>
static void buildApiCall (UT_WorkBuffer &func, const char *api_function, Args &&...args)
 
static UT_StringHolder determineCAPath ()
 
static UT_StringHolder determineCAInfo ()
 
static UT_StringHolder encodeVariables (const WebMap &variables)
 

Detailed Description

Definition at line 236 of file NET_WebAPI.h.

Member Typedef Documentation

Definition at line 240 of file NET_WebAPI.h.

Member Function Documentation

template<typename... Args>
void NET_WebAPI::buildApiCall ( UT_WorkBuffer func,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Build a json api function with the provided api function name and args. The result is placed in the func parameter.

Definition at line 422 of file NET_WebAPI.h.

template<typename... Args>
static NET_HTTPResponse NET_WebAPI::call ( const UT_Url api_url,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Definition at line 249 of file NET_WebAPI.h.

template<typename... Args>
static NET_HTTPResponse NET_WebAPI::call ( const UT_Url api_url,
const NET_WebMap headers,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Definition at line 260 of file NET_WebAPI.h.

template<typename... Args>
static NET_HTTPResponse NET_WebAPI::call ( NET_NetSession session,
const UT_Url api_url,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Definition at line 272 of file NET_WebAPI.h.

template<typename... Args>
static NET_WebAPIResponse NET_WebAPI::call ( NET_WebSocketSPtr  ws,
std::chrono::milliseconds  timeout,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Definition at line 283 of file NET_WebAPI.h.

template<typename... Args>
static NET_Future<NET_WebAPIResponse> NET_WebAPI::callAsync ( NET_WebSocketSPtr  ws,
const char *  api_function,
Args &&...  args 
)
inlinestatic

Definition at line 311 of file NET_WebAPI.h.

static UT_StringHolder NET_WebAPI::decodeUri ( const UT_StringView  uri)
static
static UT_StringHolder NET_WebAPI::determineCAInfo ( )
static
static UT_StringHolder NET_WebAPI::determineCAPath ( )
static
static UT_StringHolder NET_WebAPI::encodeUri ( const UT_StringView  uri)
static
static UT_StringHolder NET_WebAPI::encodeVariables ( const WebMap variables)
static

The documentation for this class was generated from the following file: