Class LicenceHelper

Namespace

SecureExchangesSDK.Helpers

Assembly

SecureExchangesSDK.NetCore.dll

This helper help you to manage a licence

public static class LicenceHelper

Inheritance

object

LicenceHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

PLANID_APICOMPLET

public const string PLANID_APICOMPLET = "APICOMPLET"

Field Value

string

PLANID_APICOMPLET2100

public const string PLANID_APICOMPLET2100 = "APICOMPLET2100"

Field Value

string

PLANID_APIDEBASE

Basic API plan

public const string PLANID_APIDEBASE = "APIDEBASE"

Field Value

string

PLANID_COMPLET

public const string PLANID_COMPLET = "COMPLET"

Field Value

string

PLANID_COMPLET10000

public const string PLANID_COMPLET10000 = "COMPLET10000"

Field Value

string

PLANID_COMPLET15000

public const string PLANID_COMPLET15000 = "COMPLET15000"

Field Value

string

PLANID_COMPLET20000

public const string PLANID_COMPLET20000 = "COMPLET20000"

Field Value

string

PLANID_COMPLET2100

public const string PLANID_COMPLET2100 = "COMPLET2100"

Field Value

string

PLANID_COMPLET2100_PARTAGER

public const string PLANID_COMPLET2100_PARTAGER = "COMPLET2100-P"

Field Value

string

PLANID_COMPLET25000

public const string PLANID_COMPLET25000 = "COMPLET25000"

Field Value

string

PLANID_COMPLET5000

public const string PLANID_COMPLET5000 = "COMPLET5000"

Field Value

string

PLANID_COMPLET7500

public const string PLANID_COMPLET7500 = "COMPLET7500"

Field Value

string

PLANID_COMPLET_PARTAGER

public const string PLANID_COMPLET_PARTAGER = "COMPLET-P"

Field Value

string

PLANID_DEBASE

Basic plan

public const string PLANID_DEBASE = "DEBASE"

Field Value

string

PLANID_DEBASE_PARTAGER

public const string PLANID_DEBASE_PARTAGER = "DEBASE-P"

Field Value

string

PLANID_NOTSET

public const string PLANID_NOTSET = "NotSet"

Field Value

string

PLANID_SESAR

public const string PLANID_SESAR = "SESAR"

Field Value

string

Properties

DeviceID

public static string DeviceID { get; }

Property Value

string

DeviceIDPrefix

Sometime two device have the same name, but need to use different licence. The prefix is used to eleminate that case. Use set a prefix to one of the both licence the most earlier possible in your project.

public static string DeviceIDPrefix { get; set; }

Property Value

string

Methods

CreateLicence(CreateLicenceArgs)

This method will create a Licence object, This object contains your authentication, encrypted.

public static Licence CreateLicence(CreateLicenceArgs args)

Parameters

args CreateLicenceArgs

CreateLicenceArgs

Returns

Licence

Return a licence Objects

GetBackLicence(GetBackLicenceArgs)

To received your activation link by email or SMS. Depend of your licence contact. That method will send you an email or SMS

public static void GetBackLicence(GetBackLicenceArgs args)

Parameters

args GetBackLicenceArgs

GetBackLicenceArgs

GetLicenceAutorisation(GetLicenceAutorisationArgs)

Get licence permission

public static LicenceAutorisation GetLicenceAutorisation(GetLicenceAutorisationArgs args)

Parameters

args GetLicenceAutorisationArgs

GetLicenceAutorisationArgs

Returns

LicenceAutorisation

Return a licenceautorisation object. Will give your permission, maxsize and maxminretention

GetSerialInfo(GetSerialInfoArgs)

Retreive Serial informations.

public static GetSerialInfoResponse GetSerialInfo(GetSerialInfoArgs args)

Parameters

args GetSerialInfoArgs

Returns

GetSerialInfoResponse

Response contain information about the serial number

GetTrial(GetTrialArgs)

This method will help you to get a trial

public static bool GetTrial(GetTrialArgs args)

Parameters

args GetTrialArgs

GetTrialArgs

Returns

bool

If the trial request is successful executed you will received true

IsLicenceIsValid(IsLicenceIsValidArgs)

This method will validate if the Serial, APIUser, APIPassword and email are valid

public static bool IsLicenceIsValid(IsLicenceIsValidArgs args)

Parameters

args IsLicenceIsValidArgs

IsLicenceIsValidArgs

Returns

bool

true / false

LoadLicenceFromFile(string, string)

Use a .sel file, and retreived the licence Informations

public static Licence LoadLicenceFromFile(string email, string licencePath)

Parameters

email string

The licence of the email need to be returned

licencePath string

The path to the file

Returns

Licence