ServiceProviderRequest class

Version:

The following table describes the properties of the ServiceProviderRequest class:

NameDescription
AuthenticationTokenAutomatically populated by the framework on every call, but you can explicitly set it on every call if needed, which overrides the automatic setting. See the AuthenticationTokenProvider class.
CurrencyCodeAutomatically populated by the framework on every call, but you can explicitly set it on every call if needed, which overrides the automatic setting. See RequestCurrencyProvider.
PropertiesKey/value property collection. You can use it as an extensibility method for passing extra request parameters to the Connect service layer. If these are required, they are defined by the ECS implementation.
Note

It is best practice to use strongly typed parameters by extending the

ServiceProviderRequest parameter on every call as opposed to using the weakly typed approach of using the Properties collection.
RequestContextAllows you to pass in additional request context that might be required by an ECS specific implementation. It also serves as a means for processors to exchange information between them without affecting the original request. The RequestContext is passed along to each processor and any additional pipeline that might be called along the way.

An example of how to use the RequestContext parameter is provided later in this document.
SelectedUICultureAutomatically populated on each call with the currently selected Sitecore language name.
ShopAutomatically populated by the framework on every call, but you can explicitly set it on each call if needed, which overrides the automatic setting. See the shop provider.
If you have suggestions for improving this article, let us know!