Class ViewDataExtensions

Inheritance

System.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
System.String

View Source

TokenInstallApiBaseUrl

Declaration

public const string TokenInstallApiBaseUrl = "InstallApiBaseUrl"

Field Value

Type	Description
System.String

View Source

TokenPasswordResetCode

Declaration

public const string TokenPasswordResetCode = "PasswordResetCode"

Field Value

Type	Description
System.String

View Source

TokenTwoFactorRequired

Declaration

public const string TokenTwoFactorRequired = "TwoFactorRequired"

Field Value

Type	Description
System.String

View Source

TokenUmbracoBaseFolder

Declaration

public const string TokenUmbracoBaseFolder = "UmbracoBaseFolder"

Field Value

Type	Description
System.String

View Source

TokenUmbracoPath

Declaration

public const string TokenUmbracoPath = "UmbracoPath"

Field Value

Type	Description
System.String

View Source

TokenUmbracoVersion

Declaration

public const string TokenUmbracoVersion = "UmbracoVersion"

Field Value

Type	Description
System.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
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
Microsoft.AspNetCore.Http.HttpContext	httpContext
System.String	cookieName
IJsonSerializer	serializer

Returns

Type	Description
System.Boolean

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
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionary	tempData
System.String	token

Returns

Type	Description
System.Boolean

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
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData

Returns

Type	Description
System.Nullable<BackOfficeExternalLoginProviderErrors>

View Source

GetInstallApiBaseUrl(ViewDataDictionary)

Declaration

public static string GetInstallApiBaseUrl(this ViewDataDictionary viewData)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData

Returns

Type	Description
System.String

View Source

GetUmbracoBaseFolder(ViewDataDictionary)

Declaration

public static string GetUmbracoBaseFolder(this ViewDataDictionary viewData)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData

Returns

Type	Description
System.String

View Source

GetUmbracoPath(ViewDataDictionary)

Declaration

public static string GetUmbracoPath(this ViewDataDictionary viewData)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData

Returns

Type	Description
System.String

View Source

GetUmbracoVersion(ViewDataDictionary)

Declaration

public static SemVersion? GetUmbracoVersion(this ViewDataDictionary viewData)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData

Returns

Type	Description
System.Nullable<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
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
BackOfficeExternalLoginProviderErrors	errors

View Source

SetInstallApiBaseUrl(ViewDataDictionary, String)

Declaration

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

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
System.String	value

View Source

SetTwoFactorProviderNames(ViewDataDictionary, IEnumerable<String>)

Declaration

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

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
IEnumerable<System.String>	providerNames

View Source

SetUmbracoBaseFolder(ViewDataDictionary, String)

Declaration

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

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
System.String	value

View Source

SetUmbracoPath(ViewDataDictionary, String)

Declaration

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

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
System.String	value

View Source

SetUmbracoVersion(ViewDataDictionary, SemVersion)

Declaration

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

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ViewFeatures.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
Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary	viewData
IEnumerable<System.String>	providerNames

Returns

Type	Description
System.Boolean