Class LicenceHelper

This helper help you to manage a licence

Inheritance

System.Object

LicenceHelper

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SecureExchangesSDK.Helpers

Assembly: SecureExchangesSDK.dll

Syntax

public static class LicenceHelper

Fields

PLANID_APICOMPLET

Declaration

public const string PLANID_APICOMPLET = "APICOMPLET"

Field Value

Type	Description
System.String

PLANID_APICOMPLET2100

Declaration

public const string PLANID_APICOMPLET2100 = "APICOMPLET2100"

Field Value

Type	Description
System.String

PLANID_APIDEBASE

Basic API plan

Declaration

public const string PLANID_APIDEBASE = "APIDEBASE"

Field Value

Type	Description
System.String

PLANID_COMPLET

Declaration

public const string PLANID_COMPLET = "COMPLET"

Field Value

Type	Description
System.String

PLANID_COMPLET_PARTAGER

Declaration

public const string PLANID_COMPLET_PARTAGER = "COMPLET-P"

Field Value

Type	Description
System.String

PLANID_COMPLET10000

Declaration

public const string PLANID_COMPLET10000 = "COMPLET10000"

Field Value

Type	Description
System.String

PLANID_COMPLET15000

Declaration

public const string PLANID_COMPLET15000 = "COMPLET15000"

Field Value

Type	Description
System.String

PLANID_COMPLET20000

Declaration

public const string PLANID_COMPLET20000 = "COMPLET20000"

Field Value

Type	Description
System.String

PLANID_COMPLET2100

Declaration

public const string PLANID_COMPLET2100 = "COMPLET2100"

Field Value

Type	Description
System.String

PLANID_COMPLET2100_PARTAGER

Declaration

public const string PLANID_COMPLET2100_PARTAGER = "COMPLET2100-P"

Field Value

Type	Description
System.String

PLANID_COMPLET25000

Declaration

public const string PLANID_COMPLET25000 = "COMPLET25000"

Field Value

Type	Description
System.String

PLANID_COMPLET5000

Declaration

public const string PLANID_COMPLET5000 = "COMPLET5000"

Field Value

Type	Description
System.String

PLANID_COMPLET7500

Declaration

public const string PLANID_COMPLET7500 = "COMPLET7500"

Field Value

Type	Description
System.String

PLANID_DEBASE

Basic plan

Declaration

public const string PLANID_DEBASE = "DEBASE"

Field Value

Type	Description
System.String

PLANID_DEBASE_PARTAGER

Declaration

public const string PLANID_DEBASE_PARTAGER = "DEBASE-P"

Field Value

Type	Description
System.String

PLANID_NOTSET

Declaration

public const string PLANID_NOTSET = "NotSet"

Field Value

Type	Description
System.String

PLANID_SESAR

Declaration

public const string PLANID_SESAR = "SESAR"

Field Value

Type	Description
System.String

Properties

DeviceID

Declaration

public static string DeviceID { get; }

Property Value

Type	Description
System.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.

Declaration

public static string DeviceIDPrefix { get; set; }

Property Value

Type	Description
System.String

Methods

CreateLicence(CreateLicenceArgs)

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

Declaration

public static Licence CreateLicence(CreateLicenceArgs args)

Parameters

Type	Name	Description
CreateLicenceArgs	args	CreateLicenceArgs

Returns

Type	Description
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

Declaration

public static void GetBackLicence(GetBackLicenceArgs args)

Parameters

Type	Name	Description
GetBackLicenceArgs	args	GetBackLicenceArgs

GetLicenceAutorisation(GetLicenceAutorisationArgs)

Get licence permission

Declaration

public static LicenceAutorisation GetLicenceAutorisation(GetLicenceAutorisationArgs args)

Parameters

Type	Name	Description
GetLicenceAutorisationArgs	args	GetLicenceAutorisationArgs

Returns

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

GetSerialInfo(GetSerialInfoArgs)

Retreive Serial informations.

Declaration

public static GetSerialInfoResponse GetSerialInfo(GetSerialInfoArgs args)

Parameters

Type	Name	Description
GetSerialInfoArgs	args

Returns

Type	Description
GetSerialInfoResponse	Response contain information about the serial number

Examples

 GetSerialInfoResponse rep = MessageHelper.GetSerialInfo(new GetSerialInfoArgs(
 new Uri("https://www.secure-exchanges.com/_api/0217/0217.asmx"),
       [your serial],
       [your apiuser],
       [your apipsw]));

GetTrial(GetTrialArgs)

This method will help you to get a trial

Declaration

public static bool GetTrial(GetTrialArgs args)

Parameters

Type	Name	Description
GetTrialArgs	args	GetTrialArgs

Returns

Type	Description
System.Boolean	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

Declaration

public static bool IsLicenceIsValid(IsLicenceIsValidArgs args)

Parameters

Type	Name	Description
IsLicenceIsValidArgs	args	IsLicenceIsValidArgs

Returns

Type	Description
System.Boolean	true / false

LoadLicenceFromFile(String, String)

Use a .sel file, and retreived the licence Informations

Declaration

public static Licence LoadLicenceFromFile(string email, string licencePath)

Parameters

Type	Name	Description
System.String	email	The licence of the email need to be returned
System.String	licencePath	The path to the file

Returns

Type	Description
Licence