Click or drag to resize

ILicensingProviderGetFreeLicence Method
Authenticates using the 'free' account which is also known as a 'guest' account. This account can be used for evaluation or demonstrations without the need to register a custom account. The account only has access to demonstration customers and jobs and its performance is throttled.

Namespace: RCS.Carbon.Licensing.Shared
Assembly: RCS.Carbon.Licensing.Shared (in RCS.Carbon.Licensing.Shared.dll) Version: 9.1.14
Syntax
C#
Copy
Task<LicenceFull> GetFreeLicence(
	string clientIdentifier = null,
	bool skipCache = false
)

Parameters

clientIdentifier  String  (Optional)
A value the identifies the caller using the free account login. The value should be an email address, a company name or a contact person's name to assist logging usage of the free account. Licensing providers are may optionally enforce special formats or requiements of this value if necessary.
skipCache  Boolean  (Optional)
Some licensing providers may use caching of login credentials to improve performance. The provider may recognise a true value as a request to skip caching.

Return Value

TaskLicenceFull
An instance of a LicenceFull class which contains information about the user account.
Exceptions
ExceptionCondition
ApplicationException

The underlying licensing system is expected to throw an ApplicationException when there is some kind of authentication failure. The Message property is expected to contain a concise explanation of the error. The Data collection property contains the following items:

KeyValue
Code A required Int32 error code which corresponds to one of the RCS.Licensing.Stdlib.LicensingResult enum values.
Note An optional string message that can contain a more detailed explanation of the error.
See Also