Show / Hide Table of Contents

Interface INSLicenseService

Interface implemented by the LicenseService.

Namespace: SuperOffice.License
Assembly: SoLicense.dll
Syntax
public interface INSLicenseService

Methods

AcceptLicense(AcceptLicenseRequest)

Accent a license

Declaration
void AcceptLicense(AcceptLicenseRequest req)
Parameters
Type Name Description
AcceptLicenseRequest req

Request

ChangeSerialNumber(ChangeSerialNumberRequest)

Reqest to change serial number

Declaration
ChangeSerialNumberResult ChangeSerialNumber(ChangeSerialNumberRequest req)
Parameters
Type Name Description
ChangeSerialNumberRequest req

Request to change serial number

Returns
Type Description
ChangeSerialNumberResult

Response to change serial number.

GetCurrentLicenseInfo(GetCurrentLicenseInfoRequest)

Get current license info

Declaration
GetCurrentLicenseInfoResult GetCurrentLicenseInfo(GetCurrentLicenseInfoRequest req)
Parameters
Type Name Description
GetCurrentLicenseInfoRequest req

Request

Returns
Type Description
GetCurrentLicenseInfoResult

Response

GetCurrentLicenseInfoWithAssignments(GetCurrentLicenseInfoWithAssignmentsRequest)

Tell the license server the actual license usage. Used during upgrade/transition from old to new pricelist. Calling this will make the transition permanent.

Declaration
GetCurrentLicenseInfoWithAssignmentsResult GetCurrentLicenseInfoWithAssignments(GetCurrentLicenseInfoWithAssignmentsRequest req)
Parameters
Type Name Description
GetCurrentLicenseInfoWithAssignmentsRequest req

Current license info + sites + users with all license assignments

Returns
Type Description
GetCurrentLicenseInfoWithAssignmentsResult

Upgraded license info with site + user assignments and possible new serial number.

GetLicenseModuleDetails(string, GetLicenseModuleDetailsRequest)

Interface implemented by the LicenseService.

Declaration
string GetLicenseModuleDetails(string url, GetLicenseModuleDetailsRequest req)
Parameters
Type Name Description
string url
GetLicenseModuleDetailsRequest req
Returns
Type Description
string

GetLicenseUrl(string)

Return the potentially overridden license server URL. Checks appSettings "SuperLicenseSvcUrl" value for override.

Declaration
string GetLicenseUrl(string url)
Parameters
Type Name Description
string url

License URL we think we should call

Returns
Type Description
string

License URL we should actually call (usually the same as the input parameter)

GetShopUrl(GetShopUrlRequest)

Get the shop URL for the Admin button to point to.

Declaration
string GetShopUrl(GetShopUrlRequest req)
Parameters
Type Name Description
GetShopUrlRequest req

Request

Returns
Type Description
string

MakeTestLicense(string, MakeTestLicenseRequest)

Make a test license

Declaration
MakeTestLicenseResult MakeTestLicense(string url, MakeTestLicenseRequest req)
Parameters
Type Name Description
string url

Request

MakeTestLicenseRequest req

Url of the service to send the request

Returns
Type Description
MakeTestLicenseResult

Response

PingLicenseSystem(CheckLicenseStatusRequest)

Ping the license service

Declaration
CheckLicenseStatusResult PingLicenseSystem(CheckLicenseStatusRequest req)
Parameters
Type Name Description
CheckLicenseStatusRequest req

Request

Returns
Type Description
CheckLicenseStatusResult

Ping response

SetLicenseUrlOverride(string)

Set license URL override - used by windows ServerSetup and DbSetup

Declaration
void SetLicenseUrlOverride(string licenseUrlOverride)
Parameters
Type Name Description
string licenseUrlOverride

Use this URL instead of the one on the license

SetTimeout(int)

Interface implemented by the LicenseService.

Declaration
void SetTimeout(int numSeconds)
Parameters
Type Name Description
int numSeconds

UpdateLicense(UpdateLicenseRequest)

Tell the license server the actual license usage. Used during upgrade/transition from old to new pricelist. Calling this will make the transition permanent.

Declaration
UpdateLicenseResult UpdateLicense(UpdateLicenseRequest req)
Parameters
Type Name Description
UpdateLicenseRequest req

Current license info + user-license usage counts

Returns
Type Description
UpdateLicenseResult

Updated license info. This needs to sent to AcceptLicense after writing to local db.

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top