XUserGetTokenAndSignatureAsync

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

ユーザー トークンと署名を取得するためのオプション。

メソッド _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;
}

要件

ヘッダー: XUser.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XUser

XUserGetTokenAndSignatureResult

XUserGetTokenAndSignatureResultSize