Click or drag to resize

ILicensingProvider Methods

The ILicensingProvider type exposes the following members.

Methods
  Name Description
Public method AuthenticateId Authenticates a licensing account user Id and password.
Public method AuthenticateName Authenticates a licensing account user name and password.
Public method ConnectRealmChildCustomers Connects a Realm to Customers to create relationships.
Public method DeleteRealm Deletes a Realm and any relationships it has with other licensing entities (a 'deep' delete).
Public method DisconnectRealmChildCustomer Disconnects the relationship between a Realm and a Customer.
Public method GetDatabaseReport Gets a set of summary items representing problems or inconsistencies in the licensing database entities.
Public method GetFreeLicence 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.
Public method GetNavigationData Gets abbreviated arrays of all Realms, Users, Customers and Jobs in the licensing database. Clients can 'join' the arrays to create custom navigation views such as a tree showing the relationships between the entities and allowing simple selection.
Public method ListRealms Returns a set of all full Realm entities in the licensing database. The Realms are not 'deep' loaded and the relationship properties will be null.
Public method ListTSAPIVisibleJobs Returns a list of jobs (surveys) that can be exported in TSAPI format.
Public method ReadRealm Reads a Realm entity by primary key Id. The Realm is 'deep' loaded so that relationship properties are filled with the related entities.
Public method ReadRealmsByName Returns a set of Realm entities matching a Name. The Realms are 'deep' loaded so that relationship properties are filled with the related entities.
Public method ReplaceRealmChildCustomers Replaces all of a Realm's connections (relationships) to customers.
Public method UpdateRealm Updates or inserts a Realm.
Public method ValidateRealm Validates a Realm.
Top
See Also