Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineIdentity
Description
Clear an auth token associated with the user, if one was cached.
If an auth token is obtained for some other purpose than user account login, it would be ignored an replaced with another when an actual login attempt is made, wasting the previously obtained one. Caching avoids that potential waste, but must be manually cleared client-side when the login completes due to the remote side has consuming it.
| Name | ClearCachedAuthToken |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineIdentityInterface.h |
| Include Path | #include "Interfaces/OnlineIdentityInterface.h" |
virtual void ClearCachedAuthToken
(
const FUniqueNetId & UserId
)
Parameters
| Name | Remarks |
|---|---|
| UserId | the unique net of the associated user |