Class ViewDataExtensions

Namespace

Umbraco.Extensions

Assembly

Umbraco.Web.Common.dll

public static class ViewDataExtensions

Inheritance

object

ViewDataExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

TokenExternalSignInError

public const string TokenExternalSignInError = "ExternalSignInError"

Field Value

string

TokenInstallApiBaseUrl

public const string TokenInstallApiBaseUrl = "InstallApiBaseUrl"

Field Value

string

TokenPasswordResetCode

public const string TokenPasswordResetCode = "PasswordResetCode"

Field Value

string

TokenTwoFactorRequired

public const string TokenTwoFactorRequired = "TwoFactorRequired"

Field Value

string

TokenUmbracoBaseFolder

public const string TokenUmbracoBaseFolder = "UmbracoBaseFolder"

Field Value

string

TokenUmbracoPath

public const string TokenUmbracoPath = "UmbracoPath"

Field Value

string

TokenUmbracoVersion

public const string TokenUmbracoVersion = "UmbracoVersion"

Field Value

string

Methods

FromBase64CookieData<T>(ViewDataDictionary, HttpContext?, string, IJsonSerializer)

Copies data from a request cookie to view data and then clears the cookie in the response

public static bool FromBase64CookieData<T>(this ViewDataDictionary viewData, HttpContext? httpContext, string cookieName, IJsonSerializer serializer)

Parameters

viewData ViewDataDictionary

httpContext HttpContext

cookieName string

serializer IJsonSerializer

Returns

bool

Type Parameters

T

Remarks

This is similar to TempData but in some cases we cannot use TempData which relies on the temp data provider and session. The cookie value can either be a simple string value

FromTempData(ViewDataDictionary, ITempDataDictionary, string)

public static bool FromTempData(this ViewDataDictionary viewData, ITempDataDictionary tempData, string token)

Parameters

viewData ViewDataDictionary

tempData ITempDataDictionary

token string

Returns

bool

GetExternalSignInProviderErrors(ViewDataDictionary)

Used by the back office login screen to get any registered external login provider errors

public static BackOfficeExternalLoginProviderErrors? GetExternalSignInProviderErrors(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

BackOfficeExternalLoginProviderErrors

GetInstallApiBaseUrl(ViewDataDictionary)

public static string? GetInstallApiBaseUrl(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

string

GetPasswordResetCode(ViewDataDictionary)

[Obsolete("This is deprecated and will be removed in V15")]
public static string? GetPasswordResetCode(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

string

GetUmbracoBaseFolder(ViewDataDictionary)

public static string? GetUmbracoBaseFolder(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

string

GetUmbracoPath(ViewDataDictionary)

public static string? GetUmbracoPath(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

string

GetUmbracoVersion(ViewDataDictionary)

public static SemVersion? GetUmbracoVersion(this ViewDataDictionary viewData)

Parameters

viewData ViewDataDictionary

Returns

SemVersion

SetExternalSignInProviderErrors(ViewDataDictionary, BackOfficeExternalLoginProviderErrors)

Used by the back office controller to register any external login provider errors

public static void SetExternalSignInProviderErrors(this ViewDataDictionary viewData, BackOfficeExternalLoginProviderErrors errors)

Parameters

viewData ViewDataDictionary

errors BackOfficeExternalLoginProviderErrors

SetInstallApiBaseUrl(ViewDataDictionary, string?)

public static void SetInstallApiBaseUrl(this ViewDataDictionary viewData, string? value)

Parameters

viewData ViewDataDictionary

value string

SetPasswordResetCode(ViewDataDictionary, string)

[Obsolete("This is deprecated and will be removed in V15")]
public static void SetPasswordResetCode(this ViewDataDictionary viewData, string value)

Parameters

viewData ViewDataDictionary

value string

SetTwoFactorProviderNames(ViewDataDictionary, IEnumerable<string>)

public static void SetTwoFactorProviderNames(this ViewDataDictionary viewData, IEnumerable<string> providerNames)

Parameters

viewData ViewDataDictionary

providerNames IEnumerable<string>

SetUmbracoBaseFolder(ViewDataDictionary, string)

public static void SetUmbracoBaseFolder(this ViewDataDictionary viewData, string value)

Parameters

viewData ViewDataDictionary

value string

SetUmbracoPath(ViewDataDictionary, string)

public static void SetUmbracoPath(this ViewDataDictionary viewData, string value)

Parameters

viewData ViewDataDictionary

value string

SetUmbracoVersion(ViewDataDictionary, SemVersion)

public static void SetUmbracoVersion(this ViewDataDictionary viewData, SemVersion version)

Parameters

viewData ViewDataDictionary

version SemVersion

TryGetTwoFactorProviderNames(ViewDataDictionary, out IEnumerable<string>)

public static bool TryGetTwoFactorProviderNames(this ViewDataDictionary viewData, out IEnumerable<string> providerNames)

Parameters

viewData ViewDataDictionary

providerNames IEnumerable<string>

Returns

bool