Click or drag to resize

ILicensingProviderAuthenticateName Method
Authenticates a licensing account user name and password.

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> AuthenticateName(
	string userName,
	string password,
	bool skipCache = false
)

Parameters

userName  String
The licensing account user name is typically an easily memorable string composed from parts of a person's name, or it may be an email address. The user name must be unique within a licensing system.
password  String
An optional password to apply security to a user account. If the user account account has no password assigned to it then this parameter is ignored.
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