BabelLicenseManager

Namespace: Babel.Licensing Assembly: Babel.Licensing.dll

Provides properties and methods to manage a ILicenseProvider. This class cannot be inherited.

public sealed class BabelLicenseManager

Inheritance

object ← BabelLicenseManager

Inherited Members

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

BabelLicenseManager()

public BabelLicenseManager()

Properties

CurrentContext

Gets the current , which specifies when you can use the licensed object.

public static ILicenseContext CurrentContext { get; }

Property Value

ILicenseContext

Methods

GetLicenseProvider(Type)

Gets a registered license provider of a given type.

public static ILicenseProvider GetLicenseProvider(Type type)

Parameters

Name	Description
type Type	A

Returns

Name	Description
ILicenseProvider	The license provider instance.

IsLicensed(Type)

Returns whether the given type has a valid license.

public static bool IsLicensed(Type type)

Parameters

Name	Description
type Type	The to find a valid license for.

Returns

Name	Description
bool	true if the given type is licensed; otherwise, false.

Examples

C#

// Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(typeof(MyApp), new BabelFileLicenseProvider());

// Check if MyApp type is licensed
if (BabelLicenseManager.IsLicensed(typeof(MyApp)))
{
	// MyApp is licensed
}

VB

' Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(GetType(MyApp), New BabelFileLicenseProvider())

' Check if MyApp type is licensed
if BabelLicenseManager.IsLicensed(GetType(MyApp)) Then
	' MyApp is licensed
End if

IsLicensedAsync(Type, CancellationToken)

Async method that returns whether the given type has a valid license.

public static Task<bool> IsLicensedAsync(Type type, CancellationToken cancellationToken = default)

Parameters

Name	Description
type Type	The to find a valid license for.
cancellationToken CancellationToken	(Optional) A token that allows processing to be cancelled.

Returns

Name	Description
Task<bool>	true if the given type is licensed; otherwise, false.

IsValid(Type)

Determines whether a valid license can be granted for the specified type.

public static bool IsValid(Type type)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.

Returns

Name	Description
bool	true if a valid license can be granted; otherwise, false.

IsValid(Type, object, out ILicense)

Determines whether a valid license can be granted for the specified instance of the type. This method creates a valid License.

public static bool IsValid(Type type, object instance, out ILicense license)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.
instance object	An object of the specified type or a type derived from the specified type.
license ILicense	A that is a valid license, or null if a valid license cannot be granted.

Returns

Name	Description
bool	true if a valid license can be granted; otherwise, false.

RegisterLicenseProvider(Type, ILicenseProvider)

Registers the license provider.

public static void RegisterLicenseProvider(Type type, ILicenseProvider provider)

Parameters

Name	Description
type Type	A
provider ILicenseProvider	The license provider instance.

Examples

C#

// Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(typeof(MyApp), new BabelRegistryLicenseProvider());

// Validate the license using the RegistryLicenseProvider
ILicense license = BabelLicenseManager.Validate(typeof(MyApp), this);

VB

' Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(GetType(MyApp), New BabelRegistryLicenseProvider())

' Validate the license using the RegistryLicenseProvider
Dim license As ILicense = BabelLicenseManager.Validate(GetType(MyApp), Me)

Validate(Type)

Determines whether a license can be granted for the specified type.

public static void Validate(Type type)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.

Examples

C#

// Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(typeof(MyApp), new BabelRegistryLicenseProvider());

// Validate the license using the BabelRegistryLicenseProvider
try
{
    ILicense license = BabelLicenseManager.Validate(typeof(MyApp));
    // ...
}
catch (BabelLicenseException ex)
{
	// Handle license validation errors
}

VB

' Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(GetType(MyApp), New BabelRegistryLicenseProvider())

' Validate the license using the BabelRegistryLicenseProvider
Try
    Dim license As ILicense = BabelLicenseManager.Validate(GetType(MyApp))
    ' ...
Catch ex As BabelLicenseException
    ' Handle license validation errors
End Try

Exceptions

Name	Description
BabelLicenseException	A License cannot be granted.

Validate(Type, object)

Determines whether a license can be granted for the instance of the specified type.

public static ILicense Validate(Type type, object instance)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.
instance object	An object of the specified type or a type derived from the specified type.

Returns

Name	Description
ILicense	An valid license.

Examples

C#

// Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(typeof(MyApp), new BabelRegistryLicenseProvider());

// Validate the license using the BabelRegistryLicenseProvider
try
{
    ILicense license = BabelLicenseManager.Validate(typeof(MyApp));
    // ...
}
catch (BabelLicenseException ex)
{
	// Handle license validation errors
}

VB

' Register the license provider before calling any BabelLicenseManager validation method
BabelLicenseManager.RegisterLicenseProvider(GetType(MyApp), New BabelRegistryLicenseProvider())

' Validate the license using the BabelRegistryLicenseProvider
Try
    Dim license As ILicense = BabelLicenseManager.Validate(GetType(MyApp))
    ' ...
Catch ex As BabelLicenseException
    ' Handle license validation errors
End Try

Exceptions

Name	Description
BabelLicenseException	The type is licensed, but a License cannot be granted.

ValidateAsync(Type, CancellationToken)

Determines whether a license can be granted for the specified type.

public static Task<ILicense> ValidateAsync(Type type, CancellationToken cancellationToken = default)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.
cancellationToken CancellationToken	(Optional) A token that allows processing to be cancelled.

Returns

Name	Description
Task<ILicense>

Exceptions

Name	Description
BabelLicenseException

ValidateAsync(Type, object, CancellationToken)

Determines whether a license can be granted for the instance of the specified type.

public static Task<ILicense> ValidateAsync(Type type, object instance, CancellationToken cancellationToken = default)

Parameters

Name	Description
type Type	A that represents the type of object that requests the license.
instance object	An object of the specified type or a type derived from the specified type.
cancellationToken CancellationToken	(Optional) A token that allows processing to be cancelled.

Returns

Name	Description
Task<ILicense>	An valid license.

Exceptions

Name	Description
BabelLicenseException	The type is licensed, but a License cannot be granted.