View Source

Class ViewDataExtensions

Inheritance
object
Namespace: Umbraco.Extensions
Assembly: Umbraco.Web.Common.dll
Syntax
public static class ViewDataExtensions

Fields

View Source

TokenExternalSignInError

Declaration
public const string TokenExternalSignInError = "ExternalSignInError"
Field Value
Type Description
string
View Source

TokenInstallApiBaseUrl

Declaration
public const string TokenInstallApiBaseUrl = "InstallApiBaseUrl"
Field Value
Type Description
string
View Source

TokenPasswordResetCode

Declaration
public const string TokenPasswordResetCode = "PasswordResetCode"
Field Value
Type Description
string
View Source

TokenTwoFactorRequired

Declaration
public const string TokenTwoFactorRequired = "TwoFactorRequired"
Field Value
Type Description
string
View Source

TokenUmbracoBaseFolder

Declaration
public const string TokenUmbracoBaseFolder = "UmbracoBaseFolder"
Field Value
Type Description
string
View Source

TokenUmbracoPath

Declaration
public const string TokenUmbracoPath = "UmbracoPath"
Field Value
Type Description
string
View Source

TokenUmbracoVersion

Declaration
public const string TokenUmbracoVersion = "UmbracoVersion"
Field Value
Type Description
string

Methods

View Source

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

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

Declaration
public static bool FromBase64CookieData<T>(this ViewDataDictionary viewData, HttpContext? httpContext, string cookieName, IJsonSerializer serializer)
Parameters
Type Name Description
ViewDataDictionary viewData
HttpContext httpContext
string cookieName
IJsonSerializer serializer
Returns
Type Description
bool
Type Parameters
Name Description
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

View Source

FromTempData(ViewDataDictionary, ITempDataDictionary, string)

Declaration
public static bool FromTempData(this ViewDataDictionary viewData, ITempDataDictionary tempData, string token)
Parameters
Type Name Description
ViewDataDictionary viewData
ITempDataDictionary tempData
string token
Returns
Type Description
bool
View Source

GetExternalSignInProviderErrors(ViewDataDictionary)

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

Declaration
public static BackOfficeExternalLoginProviderErrors? GetExternalSignInProviderErrors(this ViewDataDictionary viewData)
Parameters
Type Name Description
ViewDataDictionary viewData
Returns
Type Description
BackOfficeExternalLoginProviderErrors
View Source

GetInstallApiBaseUrl(ViewDataDictionary)

Declaration
public static string? GetInstallApiBaseUrl(this ViewDataDictionary viewData)
Parameters
Type Name Description
ViewDataDictionary viewData
Returns
Type Description
string
View Source

GetUmbracoBaseFolder(ViewDataDictionary)

Declaration
public static string? GetUmbracoBaseFolder(this ViewDataDictionary viewData)
Parameters
Type Name Description
ViewDataDictionary viewData
Returns
Type Description
string
View Source

GetUmbracoPath(ViewDataDictionary)

Declaration
public static string? GetUmbracoPath(this ViewDataDictionary viewData)
Parameters
Type Name Description
ViewDataDictionary viewData
Returns
Type Description
string
View Source

GetUmbracoVersion(ViewDataDictionary)

Declaration
public static SemVersion? GetUmbracoVersion(this ViewDataDictionary viewData)
Parameters
Type Name Description
ViewDataDictionary viewData
Returns
Type Description
SemVersion
View Source

SetExternalSignInProviderErrors(ViewDataDictionary, BackOfficeExternalLoginProviderErrors)

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

Declaration
public static void SetExternalSignInProviderErrors(this ViewDataDictionary viewData, BackOfficeExternalLoginProviderErrors errors)
Parameters
Type Name Description
ViewDataDictionary viewData
BackOfficeExternalLoginProviderErrors errors
View Source

SetInstallApiBaseUrl(ViewDataDictionary, string?)

Declaration
public static void SetInstallApiBaseUrl(this ViewDataDictionary viewData, string? value)
Parameters
Type Name Description
ViewDataDictionary viewData
string value
View Source

SetTwoFactorProviderNames(ViewDataDictionary, IEnumerable<string>)

Declaration
public static void SetTwoFactorProviderNames(this ViewDataDictionary viewData, IEnumerable<string> providerNames)
Parameters
Type Name Description
ViewDataDictionary viewData
IEnumerable<string> providerNames
View Source

SetUmbracoBaseFolder(ViewDataDictionary, string)

Declaration
public static void SetUmbracoBaseFolder(this ViewDataDictionary viewData, string value)
Parameters
Type Name Description
ViewDataDictionary viewData
string value
View Source

SetUmbracoPath(ViewDataDictionary, string)

Declaration
public static void SetUmbracoPath(this ViewDataDictionary viewData, string value)
Parameters
Type Name Description
ViewDataDictionary viewData
string value
View Source

SetUmbracoVersion(ViewDataDictionary, SemVersion)

Declaration
public static void SetUmbracoVersion(this ViewDataDictionary viewData, SemVersion version)
Parameters
Type Name Description
ViewDataDictionary viewData
SemVersion version
View Source

TryGetTwoFactorProviderNames(ViewDataDictionary, out IEnumerable<string>)

Declaration
public static bool TryGetTwoFactorProviderNames(this ViewDataDictionary viewData, out IEnumerable<string> providerNames)
Parameters
Type Name Description
ViewDataDictionary viewData
IEnumerable<string> providerNames
Returns
Type Description
bool