Click or drag to resize
ICustomerManager Interface

[This is preliminary documentation and is subject to change.]

Manager for customers

Namespace: Netadmin.Management.Customer
Assembly: Netadmin.Management.Interfaces (in Netadmin.Management.Interfaces.dll) Version: release/9.0@131b654fe7332b0776120c2b44d96c6cac5ac9a2
Syntax
Copy
public interface ICustomerManager : IManager<ICustomer>, 
	ICreateableBatch<ICustomer>, IUpdateableBatch<ICustomer>, IDetailsableBatch<ICustomer>, 
	IDeletableBatch<ICustomer>, ICreateableBatch_v2<ICustomer>, IUniqueName<ISubUserCustomer>, 
	IDropdownableMultipleCompanies, IDropdownable, IFilterable<ICustomer, ICustomerFilter>, 
	ITop100ForCompany<ICustomer>, ITop100ForCompanyAndProvider<ICustomer>

The ICustomerManager type exposes the following members.

Methods
  NameDescription
Public method void BlockCustomerFromPortal(Int64)
Blocks the specified customer from logging into the customer portal
Public methodIReadOnlyDictionaryTKey, TValue, T: GuidCreate(IReadOnlyDictionaryGuid, T)
Creates multiple entities in one operation
(Inherited from ICreateableBatch_v2T.)
Public methodIEnumerableTCreate(IEnumerableT)
Creates multiple entities in one operation
(Inherited from ICreateableBatchT.)
Public method void CreateServiceProviderCustomerInstances(IEnumerableInt64, IEnumerableInt64) Obsolete.
Creates service provider instances of customers
Public methodInt64CreateSubUserCustomer(ISubUserCustomer)
Creates a sub user for a customer
Public method void Delete(IEnumerableInt64)
Deletes multiple entities in one operation
(Inherited from IDeletableBatchT.)
Public method void DeleteSubUserCustomer(Int64)
Deletes a sub user
Public methodICustomerDetails(Int64, Int64) Obsolete.
Retrieves details on a customer
Public methodIReadOnlyDictionaryTKey, TValue, T: Int64DetailsAny(IEnumerableInt64)
Attempts to get details on multiple ids. If an id is not found, it will not be included in the returned dictionary
(Inherited from IDetailsableBatchT.)
Public methodIPaginationTFilter(TFilterDtoInterface, PaginationRequestTDToInterface)
Searches for entities using a filter and returnes a pagination based on the supplied request
(Inherited from IFilterableTDToInterface, TFilterDtoInterface.)
Public methodIEnumerableT, T: IArchivedSubscriptionGetArchivedSubscriptions(Int64)
Retrieves archived subscriptions for a customer
Public methodIEnumerableT, T: IArchivedSubscriptionGetArchivedSubscriptionsForCustomer(Int64, Int64) Obsolete.
Retrieves archived subscriptions for a customer
Public methodIEnumerableT, T: ICustomerDeviceGetCustomerEquipments(Int64)
Retrieves customer devices
Public methodIReadOnlyDictionaryTKey, TValue, T: Int64GetCustomersByAddressIds(IEnumerableInt64)
Retrieves all customers on the specified addresses
Public methodIEnumerableT, T: ICustomerGetCustomersToActivateOnAddress(Int64, Int64)
Get existing customers in the system that is not activated for the specified service provider
Public methodIEnumerableT, T: ICustomerGetCustomersWithDuplicateInvoiceNumbers(IEnumerableICustomer)
Retrieves customers whom has duplicate customer numbers, depending on company settings
Public methodIReadOnlyDictionaryTKey, TValue, T: Int64GetMessageCategories(IEnumerableInt64)
Retrieves message categories for customers
Public methodIEnumerableT, T: INameableGetNames(IEnumerableInt64)
Retrieves names for specified ids
(Inherited from IDropdownable.)
Public methodISubUserCustomerGetSubUserCustomerDetails(Int64)
Retrieves details on a customer sub user
Public methodIEnumerableT, T: ISubUserCustomerGetSubUsersForCustomer(Int64)
Retrives sub users for a customer
Public methodIReadOnlyDictionaryTKey, TValue, T: StringGetTop100(ExpressionFuncT, String, String, IEnumerableInt64)
Retrieves the first 100 matches of the search string. For each string, a maximum of 100 ids are returned. Please see the interface for the manager for documentation on supported properties and additional information
(Inherited from ITop100ForCompanyT.)
Public methodIReadOnlyDictionaryTKey, TValue, T: StringGetTop100(ExpressionFuncT, String, String, IEnumerableInt64, NullableInt64)
Retrieves the first 100 matches of the search string. For each string, a maximum of 100 ids are returned. Please see the interface for the manager for documentation on supported properties and additional information
(Inherited from ITop100ForCompanyAndProviderT.)
Public methodIEnumerableT, T: ICustomerGetUserNameDuplicates(IEnumerableICustomer)
Retrieves customers whom has duplicate usernames (not case sensitive)
Public methodBooleanIsCustomerBlocked(Int64)
Checks if the customer is blocked from the customer portal
Public methodBooleanIsNameUnique(T)
Checks if the name of a dto is unique
(Inherited from IUniqueNameT.)
Public methodIReadOnlyDictionaryTKey, TValue, T: ICustomerSSnPairIsSsnUnique(IEnumerableICustomerSSnPair, Boolean)
Validates that SSn is Unique
Public methodIReadOnlyDictionaryTKey, TValue, T: ICustomerSSnPairIsSsnValid(IEnumerableISSnValidationInput)
Validates SSn using SSn validation assembly
Public methodIEnumerableT, T: INameableListTop100ByName(Int64, String)
Lists the first 100 results starting with a partialname in an undefined order.
(Inherited from IDropdownable.)
Public methodIEnumerableT, T: INameableListTop100ByName(IEnumerableInt64, String)
Lists the first 100 results starting with a partialname in an undefined order.
(Inherited from IDropdownableMultipleCompanies.)
Public method void MarkForDeletion(IEnumerableInt64)
Marks customers for deletion to be will be deleted by maintenance plugin
Public method void SetMessageCategories(IReadOnlyDictionaryInt64, IEnumerableICustomerMessageCategoryRelation)
Sets message categories for customers. Note that this will remove any prior configuration for the customer
Public method void UnblockCustomerFromPortal(Int64)
Removes the block from the specified customer so he/she may log in to the customer portal
Public method void Update(IEnumerableT)
Updates multiple entities in one operation
(Inherited from IUpdateableBatchT.)
Public method void UpdateCustomerFromAddress(Int64, Int64, Boolean, Boolean)
Updates a customer's address details based on an address
Public method void UpdateServiceProviderCustomer(ICustomer, Int64) Obsolete.
Update a service provider instance of a customer
Public method void UpdateSubUserCustomer(ISubUserCustomer)
Updates an existing sub user
Top
Extension Methods
  NameDescription
Public Extension MethodICustomerCreateICustomer(ICustomer)
ICreateableBatchT
(Defined by CreateableBatchExtensions.)
Public Extension Method void DeleteICustomer(Int64)
IDeletableBatchT
(Defined by DeletableBatchExtensions.)
Public Extension MethodICustomerDetailsAllICustomer(Int64)Overloaded.
IDetailsableBatchT
(Defined by DetailsableBatchExtensions.)
Public Extension MethodIReadOnlyDictionaryTKey, TValue, T: Int64DetailsAllICustomer(IEnumerableInt64)Overloaded.
IDetailsableBatchT
(Defined by DetailsableBatchExtensions.)
Public Extension MethodICustomerDetailsAnyICustomer(Int64)
IDetailsableBatchT Returns details of entity with id 'id', or null if not found Thrown if any id zero or less.
(Defined by DetailsableBatchExtensions.)
Public Extension Method void UpdateICustomer(ICustomer)
IUpdateableBatchT
(Defined by UpdateableBatchExtensions.)
Top
Remarks
This interface implements two top 100 interfaces ITop100ForCompany.GetTop100(...) will return data from base customers ITop100ForCompanyAndProvider.GetTop100(...) will return data from service provider customers Supported Top100 properties: * FirstName * LastName * InvoiceNumber * CustomerNumber * Title * PhoneNumber * PhoneNumberWork * SSnOrOrganisationNumber * ApartmentAddress * StreetAddress * PostalCode * City * Country * ContactFirstName * ContactLastName * ContactReference * ContactStreetAddress * ContactCity * ContactPostalCode * ContactCountry * Email * WebsiteUrl * Note * MobileNumber * ApartmentNumber * AgreementNumber * Reference * FullName
See Also