PartyXblTokenAndSignatureRequestedStateChange
Information specific to the TokenAndSignatureRequested type of state change.
Syntax
struct PartyXblTokenAndSignatureRequestedStateChange : PartyXblStateChange {
uint32_t correlationId;
PartyString method;
PartyString url;
uint32_t headerCount;
PartyXblHttpHeader* headers;
uint32_t bodySize;
const void* body;
PartyBool forceRefresh;
PartyBool allUsers;
PartyXblLocalChatUser* localChatUser;
}
Members
correlationId
uint32_t
Opaque identifier used to associate the token and signature request with the internal HTTP request. Use this identifier when calling PartyXblManager::CompleteGetTokenAndSignatureRequest() to complete the operation.
method
PartyString
The HTTP method for the request, such as "GET" or "POST".
url
PartyString
The URL for the HTTP request that needs a token and signature (fully escaped).
headerCount
uint32_t
The number of headers for the HTTP request.
headers
PartyXblHttpHeader*
array of size headerCount
The headers for the HTTP request.
bodySize
uint32_t
The size of the request body in bytes.
body
const void*
buffer of size bodySize
bytes
The request body.
forceRefresh
PartyBool
If true
the token must be refreshed, ignoring any cached token.
allUsers
PartyBool
If true
, a token should be requested for all users rather than a specific user. In the case localChatUser
will be nullptr.
localChatUser
PartyXblLocalChatUser*
may be nullptr
The local chat user that should be used to retrieve the token and signature.
This field is only valid when allUsers
is set to false
.
Remarks
The title can use the Xbox Authentication Library (XAL) to fulfill these requests by calling the XalUserGetTokenAndSignatureSilentlyAsync() function.
Use PartyXblManager::CompleteGetTokenAndSignatureRequest() to provide the token and signature and complete the operation.
Requirements
Header: PartyXboxLive.h