Click or drag to resize

LicensingClient Class

[Missing <summary> documentation for "T:RCS.Licensing.Stdlib.LicensingClient"]

Inheritance Hierarchy
SystemObject
  RCS.Licensing.StdlibLicensingClient

Namespace: RCS.Licensing.Stdlib
Assembly: RCS.Licensing.Stdlib (in RCS.Licensing.Stdlib.dll) Version: 8.0.0+6a10b18a78f605fc5a365a56d079277e103ee6d9
Syntax
C#
Copy
public sealed class LicensingClient : IDisposable

The LicensingClient type exposes the following members.

Constructors
 NameDescription
Public methodLicensingClient Constructs a Licensing web service client helper. This class allows .NET client applications to work with the Licensing service in a strongly-typed way that avoids making direct network calls.
Top
Properties
 NameDescription
Public propertyBaseAddress Gets the Uri of the base service address being used by the instance of the licensing client.
Top
Methods
 NameDescription
Public methodChangePassword Changes a user's password.
Public methodDeleteAgency Deletes a Agency record by primary key id.
Public methodDeleteAuthority Deletes a Authority record by primary key id.
Public methodDeleteCustomer Deletes a Customer record by primary key id.
Public methodDeleteDistributor Deletes a Distributor record by primary key id.
Public methodDeleteJob Deletes a Job record by primary key id.
Public methodDeleteUser Deletes a User record by primary key id.
Public methodDisposeReleases all resources used by the LicensingClient
Public methodGetGuestJobs Lists guest jobs in the database lookup record.
Public methodGetJobPicks List abbreviated Job records that are suitable for pick lists.
Public methodStatic memberGetMac Gets the MAC for the current computer or remote session.
Public methodGetOrgTree Retrieves a complete Licensing organisation entity tree.
Public methodGetPyramidalCustomers Legacy method for calculating a user's heirarchical customer and job permissions.
Public methodGetRealCloudVartreeNames Gets a list of the 'real' vartree (*.vtr) blobs in the root of a job's container.
Public methodGetTsapiVisible Lists TSAPI visible jobs in the database lookup record.
Public methodGetUserPicks List abbreviated Uesr records that are suitable for pick lists.
Public methodIdAuthenticateText Authenticates user Id and password credentials and returns the response as plain text lines. This method works identically to IdAuthenticate(String, String) but instead of returning a strongly-typed AuthenticateResponse object, it returns the object serialized as plain text lines. This method is intended for use by clients that need compatibility with direct C++ REST calls to IdAuthenticate.
Public methodStatic memberIsMacSessionValid Validates that a Mac has valid syntax and corresponds to the current computer or remote session.
Public methodStatic memberIsMacSyntaxValid Validates the syntax of a MAC string.
Public methodStatic memberIsProductKeyValid Validates a licence key.
Public methodListAgency List all Agency records
Public methodListAgency(String) List Agency record filtered by parent distributor
Public methodListAgencyByName Lists Agency records by Name (case insensitive).
Public methodListAuthority List all Authority records
Public methodListAuthorityByName Lists Authority records by Name (case insensitive).
Public methodListCustomer List all Customer records
Public methodListCustomer(String) List Customer record filtered by parent agency
Public methodListCustomerByName Lists Customer records by Name (case insensitive).
Public methodListCustomersByUserId List Customer records that are related to a specified User Id. NOTE: In the RCS implementation this method customers with their names in the users's array values.
Public methodListDistributor List all Distributor records
Public methodListDistributor(String) List Distributor record filtered by parent authority
Public methodListDistributorByName Lists Distributor records by Name (case insensitive).
Public methodListJob List all Job records
Public methodListJob(String) List Job record filtered by parent customer
Public methodListJobByName Lists Job records by Name (case insensitive).
Public methodListJobForCustomerName List Job records that are related to a specified Customer name. NOTE: The customer name is converted into customer Ids and jobs are listed if their matches any of the customer Ids.
Public methodListJobsByNameAndCustomerId Lists jobs with a matching Name property value (case insensitive) and parent customer id.
Public methodListJobsByUserId List Job records that related to a specified User Id. NOTE: In the RCS implementation this method lists jobs with their names in the user's array values.
Public methodListUser List all User records
Public methodListUserByJobId List users filtering to those containing a specific cloud job that is validated to be a child of the user's parent customer. NOTE: The job is read to obtain its properties. Users are listed if their equals the job's parent customer id and the user's contains the job name.
Public methodListUserByName Lists User records by Name (case insensitive).
Public methodListUsersByCustomerId Lists User records with a specified parent Customer Id. NOTE: In the RCS implementation this methods converts the customer Id to a Name and lists users with that customer name in the array values.
Public methodListUsersByEntityId List User records that are related to a specified Entity Id. NOTE: Lists all user's with equal to the specified entity id.
Public methodListUsersByNameForJobId List User records that are related to a specified Job Id. NOTE: In the RCS implementation this methods converts the job Id to a Name and lists users with that job name in the array values.
Public methodNameAuthenticateText Authenticates user Name and password credentials and returns the response as plain text lines. This method works identically to NameAuthenticate(String, String) but instead of returning a strongly-typed AuthenticateResponse object, it returns the object serialized as plain text lines. This method is intended for use by clients that need compatibility with direct C++ REST calls to NameAuthenticate.
Public methodReadAgency Reads a Agency record by primary key id.
Public methodReadAuthority Reads a Authority record by primary key id.
Public methodReadCustomer Reads a Customer record by primary key id.
Public methodReadDistributor Reads a Distributor record by primary key id.
Public methodReadEntity Read an record with a specified primary key id.
Public methodReadJob Reads a Job record by primary key id.
Public methodReadManyAgency Reads multiple Agency records by their primary key ids.
Public methodReadManyAuthority Reads multiple Authority records by their primary key ids.
Public methodReadManyCustomer Reads multiple Customer records by their primary key ids.
Public methodReadManyDistributor Reads multiple Distributor records by their primary key ids.
Public methodReadManyJob Reads multiple Job records by their primary key ids.
Public methodReadManyUser Reads multiple User records by their primary key ids.
Public methodReadUser Reads a User record by primary key id.
Public methodResetPassword Resets a user's password to a random value.
Public methodReturnIdLicenceObsolete.
Attempts to return a licence that has been borrowed by an account.
Public methodUpdateAccount Updates a user's account name, email and password.
Public methodUpdateGuestJobs Updates the list of guest jobs in the database lookup record.
Public methodUpdateTsapiVisible Updates the list of TSAPI visible jobs in the database lookup record.
Public methodUpsertAgency Updates or inserts a Agency record.
Public methodUpsertAuthority Updates or inserts a Authority record.
Public methodUpsertCustomer Updates or inserts a Customer record.
Public methodUpsertDistributor Updates or inserts a Distributor record.
Public methodUpsertJob Updates or inserts a Job record.
Public methodUpsertUser Updates or inserts a User record.
Public methodValidateTsapiVisible Validates the TSAPI visible job list in the database lookup record.
Public methodStatic memberVerifySignedString Validates a string and its signature.
Top
See Also