Session - Vendr Documentation

Session Manager

ISessionManager

Description: Interface of the Vendr Session Manager
Namespace: Vendr.Core.Session
Assembly: Vendr.Core

GetCurrentOrder

Gets the Current Order of the current Session

Signature:

OrderReadOnly GetCurrentOrder(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`OrderReadOnly`	The current Order for the current Session, or `null` if there is no current Order

GetOrCreateCurrentOrder

Gets or Creates a Current Order of the current Session

Signature:

OrderReadOnly GetOrCreateCurrentOrder(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`OrderReadOnly`	The current Order for the current Session, or `null` if there is no current Order

Signature:

OrderReadOnly GetOrCreateCurrentOrder(Guid storeId, string customerReference);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`string`	`customerReference`	The unique Reference of a Customer to associate the Order with

Returns:

Type	Description
`OrderReadOnly`	The current Order for the current Session, or `null` if there is no current Order

GetCurrentFinalizedOrder

Gets the Current Finalized Order of the current Session

Signature:

OrderReadOnly GetCurrentFinalizedOrder(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`OrderReadOnly`	The current finalized Order for the current Session, or `null` if there is no current finalized Order

SetCurrentOrder

Set the Current Order of the current Session

Signature:

void SetCurrentOrder(Guid storeId, OrderReadOnly order);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`OrderReadOnly`	`order`	The Order to set the current Order of the current Session to

Signature:

void SetCurrentOrder(Guid storeId, Guid orderId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`orderId`	The ID of the Order to set the current Order of the current Session to

ClearCurrentOrder

Clear the Current Order of the current Session

Signature:

void ClearCurrentOrder(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session should be cleared for

GetDefaultCurrency

Get the default Currency of the current Session

Signature:

CurrencyReadOnly GetDefaultCurrency(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`CurrencyReadOnly`	The default Currency of the current Session

SetDefaultCurrency

Set the default Currency of the current Session

Signature:

void SetDefaultCurrency(Guid storeId, CurrencyReadOnly currency, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`CurrencyReadOnly`	`currency`	The default Currency to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultCurrency(Guid storeId, Guid currencyId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`currencyId`	The ID of the default Currency to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultCurrency

Clear the default Currency of the current Session

Signature:

void ClearDefaultCurrency(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultPaymentCountry

Get the default Payment Country of the current Session

Signature:

CountryReadOnly GetDefaultPaymentCountry(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`CountryReadOnly`	The default Payment Country of the current Session

SetDefaultPaymentCountry

Set the default Payment Country of the current Session

Signature:

void SetDefaultPaymentCountry(Guid storeId, CountryReadOnly country, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`CountryReadOnly`	`country`	The default Payment Country to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultPaymentCountry(Guid storeId, Guid countryId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`countryId`	The ID of the default Payment Country to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultPaymentCountry

Clear the default PaymentCountry of the current Session

Signature:

void ClearDefaultPaymentCountry(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultPaymentRegion

Get the default Payment Region of the current Session

Signature:

RegionReadOnly GetDefaultPaymentRegion(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`RegionReadOnly`	The default Payment Region of the current Session

SetDefaultPaymentRegion

Set the default Payment Region of the current Session

Signature:

void SetDefaultPaymentRegion(Guid storeId, RegionReadOnly region, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`RegionReadOnly`	`region`	The default Payment Region to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultPaymentRegion(Guid storeId, Guid regionId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`regionId`	The ID of the default Payment Region to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultPaymentRegion

Clear the default PaymentRegion of the current Session

Signature:

void ClearDefaultPaymentRegion(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultPaymentMethod

Get the default Payment Method of the current Session

Signature:

PaymentMethodReadOnly GetDefaultPaymentMethod(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`PaymentMethodReadOnly`	The default Payment Method of the current Session

SetDefaultPaymentMethod

Set the default Payment Method of the current Session

Signature:

void SetDefaultPaymentMethod(Guid storeId, PaymentMethodReadOnly paymentMethod, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`PaymentMethodReadOnly`	`paymentMethod`	The default Payment Method to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultPaymentMethod(Guid storeId, Guid paymentMethodId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`paymentMethodId`	The ID of the default Payment Method to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultPaymentMethod

Clear the default PaymentMethod of the current Session

Signature:

void ClearDefaultPaymentMethod(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultShippingCountry

Get the default Shipping Country of the current Session

Signature:

CountryReadOnly GetDefaultShippingCountry(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`CountryReadOnly`	The default Shipping Country of the current Session

SetDefaultShippingCountry

Set the default Shipping Country of the current Session

Signature:

void SetDefaultShippingCountry(Guid storeId, CountryReadOnly country, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`CountryReadOnly`	`country`	The default Shipping Country to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultShippingCountry(Guid storeId, Guid countryId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`countryId`	The ID of the default Shipping Country to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultShippingCountry

Clear the default ShippingCountry of the current Session

Signature:

void ClearDefaultShippingCountry(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultShippingRegion

Get the default Shipping Region of the current Session

Signature:

RegionReadOnly GetDefaultShippingRegion(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`RegionReadOnly`	The default Shipping Region of the current Session

SetDefaultShippingRegion

Set the default Shipping Region of the current Session

Signature:

void SetDefaultShippingRegion(Guid storeId, RegionReadOnly region, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`RegionReadOnly`	`region`	The default Shipping Region to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultShippingRegion(Guid storeId, Guid regionId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`regionId`	The ID of the default Shipping Region to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultShippingRegion

Clear the default ShippingRegion of the current Session

Signature:

void ClearDefaultShippingRegion(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultShippingMethod

Get the default Shipping Method of the current Session

Signature:

ShippingMethodReadOnly GetDefaultShippingMethod(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`ShippingMethodReadOnly`	The default Shipping Method of the current Session

SetDefaultShippingMethod

Set the default Shipping Method of the current Session

Signature:

void SetDefaultShippingMethod(Guid storeId, ShippingMethodReadOnly shippingMethod, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`ShippingMethodReadOnly`	`shippingMethod`	The default Shipping Method to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultShippingMethod(Guid storeId, Guid shippingMethodId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`shippingMethodId`	The ID of the default Shipping Method to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultShippingMethod

Clear the default ShippingMethod of the current Session

Signature:

void ClearDefaultShippingMethod(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

GetDefaultTaxClass

Get the default Tax Class of the current Session

Signature:

TaxClassReadOnly GetDefaultTaxClass(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

Returns:

Type	Description
`TaxClassReadOnly`	The default Tax Class of the current Session

SetDefaultTaxClass

Set the default Tax Class of the current Session

Signature:

void SetDefaultTaxClass(Guid storeId, TaxClassReadOnly taxClass, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`TaxClassReadOnly`	`taxClass`	The default Tax Class to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

Signature:

void SetDefaultTaxClass(Guid storeId, Guid taxClassId, bool applyToCurrentOrder = false);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to
`Guid`	`taxClassId`	The ID of the default Tax Class to set the current Session to
`bool`	`applyToCurrentOrder`	Flag indicating whether to apply to change to the current Order of the Session

ClearDefaultTaxClass

Clear the default Tax Class of the current Session

Signature:

void ClearDefaultTaxClass(Guid storeId);

Parameters:

Type	Name	Description
`Guid`	`storeId`	The ID of the Store the Session belongs to

SessionManager

Description: Default implementation of the Vendr Session Manager Interface
Namespace: Vendr.Core.Session
Assembly: Vendr.Core

Site + logo design © 2024 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.