XUserGetTokenAndSignatureAsync

项目
05/09/2023

异步检索 Web 请求的 xtoken 和签名。

语法

HRESULT XUserGetTokenAndSignatureAsync(  
         XUserHandle user,  
         XUserGetTokenAndSignatureOptions options,  
         const char* method,  
         const char* url,  
         size_t headerCount,  
         const XUserGetTokenAndSignatureHttpHeader* headers,  
         size_t bodySize,  
         const void* bodyBuffer,  
         XAsyncBlock* async  
)

参数

user _In_
类型：XUserHandle

Web 请求所针对的用户的句柄。

options _In_
类型：XUserGetTokenAndSignatureOptions

用于检索用户令牌和签名的选项。

method _In_z_
类型：char*

Web 请求的方法类型。

url _In_z_
类型：char*

Web 请求的 URL。

headerCount _In_
类型：size_t

headers 参数中的标头数。

headers _In_reads_opt_(headerCount)
类型：XUserGetTokenAndSignatureHttpHeader*

Web 请求的标头。

bodySize _In_
类型：size_t

bodyBuffer 参数中缓冲区的大小。

bodyBuffer _In_reads_bytes_opt_(bodySize)
类型：void*

包含 Web 请求正文的缓冲区。

async _Inout_
类型：XAsyncBlock*

用于轮询调用的状态和检索调用结果的 XAsyncBlock。

返回值

类型：HRESULT

如果成功，则返回 S_OK；否则返回错误代码。有关错误代码的列表，请参阅错误代码。

备注

要检索调用 XUserGetTokenAndSignatureAsync 的结果，请调用 XUserGetTokenAndSignatureResult。

要检索存放调用 XUserGetTokenAndSignatureAsync 的结果所需的缓冲区大小，请调用 XUserGetTokenAndSignatureResultSize。

下面的示例演示如何异步检索用户的标记和签名。

HRESULT RequestTokenComplete(XAsyncBlock* abResult)
{
    size_t bufferSize;
    RETURN_IF_FAILED(XUserGetTokenAndSignatureResultSize(abResult, &bufferSize));

    std::vector<uint8_t> buffer(bufferSize);
    XUserGetTokenAndSignatureData* data;
    if (SUCCEEDED_LOG(XUserGetTokenAndSignatureResult(abResult, buffer.size(), buffer.data(), &data, nullptr /*bufferUsed*/)))
    {
        appLog.AddLog("Token: %s\n", data->token);
        if (data->signature != nullptr)
        {    
            appLog.AddLog("Signature: %s\n", data->signature);
        }
    }

    return S_OK;
}

HRESULT RequestTokenAsync(
    XTaskQueueHandle queue,
    const char* url,
    bool forceRefresh)
{
    auto asyncBlock = std::make_unique<XAsyncBlock>();
    ZeroMemory(asyncBlock.get(), sizeof(*asyncBlock));
    asyncBlock->queue = queue;
    asyncBlock->context = this;
    asyncBlock->callback = [](XAsyncBlock* ab)
    {
        LOG_IF_FAILED(static_cast<User*>(ab->context)->RequestTokenComplete(ab));
        delete ab;
    };


    XUserGetTokenAndSignatureOptions options = XUserGetTokenAndSignatureOptions::None;

    if (forceRefresh)
    {
        WI_SET_FLAG(options, XUserGetTokenAndSignatureOptions::ForceRefresh);
    }

    static const XUserGetTokenAndSignatureHttpHeader headers[] =
    {
        { "Accept", "application/json"},
        { "Why", "Because"},
    };

    if (SUCCEEDED_LOG(XUserGetTokenAndSignatureAsync(
        _handle.get(),
        options,
        "GET",
        url,
        ARRAYSIZE(headers),
        headers,
        0,
        nullptr,
        asyncBlock.get())))
    {
        // The call succeeded, so release the std::unique_ptr ownership of XAsyncBlock* since the callback will take over ownership.
        // If the call fails, the std::unique_ptr will keep ownership and delete the XAsyncBlock*
        asyncBlock.release();
    }

    return S_OK;
}