Edit

Share via

PFAuthenticationValidateEntityTokenAsync

  • Article

Method for a server to validate a client provided EntityToken. Only callable by the title entity.

Syntax

HRESULT PFAuthenticationValidateEntityTokenAsync(  
    PFEntityHandle entityHandle,  
    const PFAuthenticationValidateEntityTokenRequest* request,  
    XAsyncBlock* async  
)

Parameters

entityHandle   PFEntityHandle

PFEntityHandle to use for authentication.

request   PFAuthenticationValidateEntityTokenRequest*

Populated request object.

async   XAsyncBlock*
Inout

XAsyncBlock for the async operation.

Return value

Type: HRESULT

Result code for this API operation.

Remarks

This API is available on Win32, Linux, and macOS. Given an entity token, validates that it hasn't expired or been revoked and will return details of the owner. When the asynchronous task is complete, call PFAuthenticationValidateEntityTokenGetResultSize and PFAuthenticationValidateEntityTokenGetResult to get the result.

Requirements

Header: PFAuthentication.h

See also

PFAuthentication members