Class UserAddressService

Namespace

Dynamicweb.Security.UserManagement

Assembly

Dynamicweb.Core.dll

public sealed class UserAddressService

Inheritance

object

UserAddressService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Delete(UserAddress)

public void Delete(UserAddress address)

Parameters

address UserAddress

DeleteByUserId(int)

Deletes all user addresses from db

public void DeleteByUserId(int userId)

Parameters

userId int

The user id

GetAddressById(int)

Gets a user address by id.

public UserAddress? GetAddressById(int id)

Parameters

id int

Identifier of a user address.

Returns

UserAddress

User address, if found; otherwise null.

GetAddresses()

Gets all user addresses.

public IEnumerable<UserAddress> GetAddresses()

Returns

IEnumerable<UserAddress>

GetAddressesByCustomerNumberAndAddressKind(string, UserAddressKind)

Gets all user addresses by customer number and the address kind. Because UserAddressKind.None indicates the address is both billing and delivery, results include addresses with UserAddressKind.None as well.

public IEnumerable<UserAddress> GetAddressesByCustomerNumberAndAddressKind(string customerNumber, UserAddressKind userAddressKind)

Parameters

customerNumber string

User's customer number.

userAddressKind UserAddressKind

The address kind.

Returns

IEnumerable<UserAddress>

All user addresses for users with the given customer number and address kind.

GetAddressesByUserCustomerNumber(string)

Gets user addresses by user customer number.

public IEnumerable<UserAddress> GetAddressesByUserCustomerNumber(string customerNumber)

Parameters

customerNumber string

The customer number.

Returns

IEnumerable<UserAddress>

GetAddressesByUserId(int)

Gets user addresses by user id.

public IEnumerable<UserAddress> GetAddressesByUserId(int userId)

Parameters

userId int

Identifier of a user.

Returns

IEnumerable<UserAddress>

GetAddressesByUserIdAndType(int, UserAddressKind)

Gets user addresses by user id and type.

public IEnumerable<UserAddress> GetAddressesByUserIdAndType(int userId, UserAddressKind addressType)

Parameters

userId int

Identifier of a user.

addressType UserAddressKind

addressType.

Returns

IEnumerable<UserAddress>

GetDefaultAddressByCustomerNumberAndAddressKind(string, UserAddressKind)

Gets the default user address by customer number and address kind. If no default address is set returns user address from AccessUserTable

public UserAddress? GetDefaultAddressByCustomerNumberAndAddressKind(string customerNumber, UserAddressKind userAddressKind)

Parameters

customerNumber string

User's customer number.

userAddressKind UserAddressKind

The address kind.

Returns

UserAddress

A user address marked as default for the users with given customer number.

GetDefaultAddressByUserId(int)

Gets the default user address by user id. If no default address is set returns user address from AccessUserTable

public UserAddress? GetDefaultAddressByUserId(int userId)

Parameters

userId int

User id to be used for searching default address

Returns

UserAddress

A user address marked as default for the given user, if found; otherwise the address stored on the user.

GetDefaultAddressByUserIdAndAddressKind(int, UserAddressKind)

Gets the default user address by user id and address kind. If no default address is set returns user address from AccessUserTable

public UserAddress? GetDefaultAddressByUserIdAndAddressKind(int userId, UserAddressKind userAddressKind)

Parameters

userId int

User id to be used for searching default address

userAddressKind UserAddressKind

The address kind.

Returns

UserAddress

A user address marked as default for the given user, if found; otherwise the address stored on the user.

HasDefaultAddressByUserId(int)

Returns true if the user has a default address

public bool HasDefaultAddressByUserId(int userId)

Parameters

userId int

User id to be used for search default address

Returns

bool

True or false

RemoveDefaultAddressByCustomerNumberAndAddressKind(string, UserAddressKind)

Removes any default address by customer number and address kind.

public void RemoveDefaultAddressByCustomerNumberAndAddressKind(string customerNumber, UserAddressKind userAddressKind)

Parameters

customerNumber string

User's customer number.

userAddressKind UserAddressKind

The address kind.

RemoveDefaultAddressByUserId(int)

Removes any default address by user id.

public void RemoveDefaultAddressByUserId(int userId)

Parameters

userId int

Identifier of a user.

RemoveDefaultAddressByUserIdAndAddressKind(int, UserAddressKind)

Removes any default address by user id and address kind.

public void RemoveDefaultAddressByUserIdAndAddressKind(int userId, UserAddressKind userAddressKind)

Parameters

userId int

Identifier of a user.

userAddressKind UserAddressKind

The address kind.

Save(UserAddress)

Saves current user address

public void Save(UserAddress address)

Parameters

address UserAddress