Class SitecoreLayoutRequest

Version: 21.x

Represents Sitecore layout service request data.

Inheritance

System.Object

SitecoreLayoutRequest

Namespace: Sitecore.LayoutService.Client.Request

Assembly: Sitecore.LayoutService.Client.Abstractions.dll

Syntax
public class SitecoreLayoutRequest : Dictionary<string, object>

Constructors

SitecoreLayoutRequest()

Initializes a new instance of the SitecoreLayoutRequest class.

Declaration
public SitecoreLayoutRequest()

Methods

ConvertValue(Object)

Converts the given value to type T.

Declaration
protected virtual T ConvertValue<T>(object value)
Parameters
TypeNameDescription
System.ObjectvalueThe input value.
Returns
TypeDescription
TAn instance of T if successful.
Type Parameters
NameDescription
TThe destination type.

TryReadValue(String, out T)

Safely gets a typed value from the underlying dictionary.

Declaration
public virtual bool TryReadValue<T>(string key, out T value)
Parameters
TypeNameDescription
System.StringkeyThe key to be located.
TvalueThe discovered value.
Returns
TypeDescription
System.BooleanTrue if successful, otherwise false.
Type Parameters
NameDescription
TThe type to be resolved.

Extension Methods

SitecoreLayoutRequestExtensions.ApiKey(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.ApiKey(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.SiteName(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.SiteName(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.Language(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.Language(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.Path(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.Path(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.Mode(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.Mode(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.PreviewDate(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.PreviewDate(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.AuthenticationHeader(SitecoreLayoutRequest)

SitecoreLayoutRequestExtensions.AuthenticationHeader(SitecoreLayoutRequest, String)

SitecoreLayoutRequestExtensions.UpdateRequest(SitecoreLayoutRequest, Dictionary<String, Object>)

SitecoreLayoutRequestExtensions.AddHeader(SitecoreLayoutRequest, String, String[])

SitecoreLayoutRequestExtensions.AddHeaders(SitecoreLayoutRequest, IDictionary<String, String[]>)

SitecoreLayoutRequestExtensions.TryGetHeadersCollection(SitecoreLayoutRequest, out Dictionary<String, String[]>)

If you have suggestions for improving this article, let us know!