ITokenCache.DeserializeMsalV3(Byte[], Boolean) Method

  • Reference

Definition

Namespace:
Microsoft.Identity.Client
Assembly:
Microsoft.Identity.Client.dll
Package:
Microsoft.Identity.Client v4.60.3

Caution

Use ITokenCacheSerializer.DeserializeMsalV3 on the TokenCacheNotificationArgs in the cache callback. Read more: https://aka.ms/msal-net-4x-cache-breaking-change

Functionality replaced by DeserializeMsalV3(Byte[], Boolean) and is accessible in TokenCacheNotificationArgs.

[System.Obsolete("Use ITokenCacheSerializer.DeserializeMsalV3 on the TokenCacheNotificationArgs in the cache callback. Read more: https://aka.ms/msal-net-4x-cache-breaking-change", false)]
public void DeserializeMsalV3 (byte[] msalV3State, bool shouldClearExistingCache = false);
[<System.Obsolete("Use ITokenCacheSerializer.DeserializeMsalV3 on the TokenCacheNotificationArgs in the cache callback. Read more: https://aka.ms/msal-net-4x-cache-breaking-change", false)>]
abstract member DeserializeMsalV3 : byte[] * bool -> unit
Public Sub DeserializeMsalV3 (msalV3State As Byte(), Optional shouldClearExistingCache As Boolean = false)

Parameters

msalV3State
Byte[]

Byte stream representation of the cache

shouldClearExistingCache
Boolean

Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state.

Attributes
ObsoleteAttribute

Remarks

This is the recommended format for maintaining SSO state between applications. SerializeMsalV3()/DeserializeMsalV3(Byte[], Boolean) is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java.

Applies to