| UpdateCheck Class | 
 Inheritance Hierarchy
Inheritance HierarchyNamespace: com.softwarekey.Client.WebService.XmlLicenseService
 Syntax
SyntaxThe UpdateCheck type exposes the following members.
 Constructors
Constructors| Name | Description | |
|---|---|---|
|  | UpdateCheck | Creates a new UpdateCheck object. | 
|  | UpdateCheck(XmlLicenseService) | Creates a new UpdateCheck object with a specified web service client (XmlLicenseService) object. | 
 Properties
Properties| Name | Description | |
|---|---|---|
|  | ActionToTake | Gets which action should be taken, as indicated by SOLO Server's response. | 
|  | ClassName | Gets or sets the class name of the WebServiceClient object.(Inherited from WebServiceCall.) | 
|  | CurrentVersion | Gets or sets the Current Version of the application.  This must be in the format X.X.X.X, where X may be any number from 0 to 99999. | 
|  | DownloadUrl | Gets the URL where the new file/update, or information on how to download the new file(s)/update(s), may be found. | 
|  | EncryptionKey | Gets or sets the author encryption key data.(Inherited from WebServiceCall.) | 
|  | ErrorMessage | Gets or sets the error message returned by the web service method call.  (See http://www.softwarekey.com/go/?ID=20 for a list of possible values.)(Inherited from WebServiceCall.) | 
|  | InformationUrl | Gets the URL where more information about the available update may be found. | 
|  | LanguageCode | Gets or sets the language code of the message to retrieve. (The default is "en", for U.S. English.) | 
|  | LastError | Gets or sets the last error which occurred.(Inherited from WebServiceCall.) | 
|  | LatestVersion | Gets the latest, free version available. | 
|  | LicenseID | Gets or sets the License ID of the activated license. | 
|  | LicenseStatus | Gets the status of the SOLO Server License ID. | 
|  | LicenseUpdate | Gets a small, arbitrary string which may be used for customized status updates. | 
|  | MethodName | Gets or sets the name of the method which will be called from the WebServiceClient object.(Inherited from WebServiceCall.) | 
|  | Password | Gets or sets the password (optional).  When a value is specified, it will be validated by SOLO Server.  This may be set to the activation password assigned to the license, or the customer password, in SOLO Server. | 
|  | ProductID | Gets or sets the Product ID.  If a Product ID is specified before calling CallWebService (this optional, but recommended), the Product ID will be validated against the License ID in SOLO Server.  When this property's value is 0 (zero), this extra validation is omitted. | 
|  | ProductUpdateName | Gets or sets the product update name to search for in SOLO Server. | 
|  | ReleaseDate | Gets the date in which the LatestVersion was released. | 
|  | ReplacedBy | Gets the License ID which has replaced this LicenseID.  A zero value means the license has not been replaced by (or upgraded to) another License ID. | 
|  | RequireSsl | Gets or sets whether or not SSL certificate validation to check.(Inherited from WebServiceCall.) | 
|  | ResultCode | Gets or sets the result code returned by the web service method call.  (See http://www.softwarekey.com/go/?ID=20 for a list of possible values.)(Inherited from WebServiceCall.) | 
|  | SessionCode | Gets or sets the randomized session code (used to deter replay attacks).(Inherited from WebServiceCall.) | 
|  | SessionCodeValidation | Gets or sets whether or not session code validation should be done automatically.(Inherited from WebServiceCall.) | 
|  | ShortMessage | Gets a short, HTML-formatted message, which may be displayed to the user. | 
|  | UseDigitalSignature | Overrides the UseDigitalSignature property to reflect the fact that this web service method does not support digital signatures.(Overrides WebServiceCallUseDigitalSignature.) | 
|  | UseEncryption | Overrides the UseEncryption property to reflect the fact that this web service method does not support encryption.(Overrides WebServiceCallUseEncryption.) | 
|  | VerifyLicenseExpirationDate | Gets or sets whether or not the License ID's expiration date will be validated.  (The default value is false.) | 
|  | WebServiceClient | Gets or sets the SoapHttpClientProtocol object (.NET Framework) or the XmlWebService object (.NET Standard 2.0) used to perform the web service method call.(Inherited from WebServiceCall.) | 
|  | WebServiceResponse | Gets or set the XmlNode object reference for the root XML node of the web service response.(Inherited from WebServiceCall.) | 
 Methods
Methods| Name | Description | |
|---|---|---|
|  | AppendSessionCode(String) | Appends the SessionCode value to an XML request string depending on the SessionCodeValidation setting, and returns the updated XML string(Inherited from WebServiceCall.) | 
|  | AppendSessionCode(XmlDocument) | Appends the SessionCode value to an XmlDocument depending on the SessionCodeValidation setting, and returns the updated XML string(Inherited from WebServiceCall.) | 
|  | CallWebService | Calls the web service method.(Inherited from WebServiceCall.) | 
|  | Equals | (Inherited from Object.) | 
|  | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.(Inherited from Object.) | 
|  | GenerateEncryptedRequest | Generates an encrypted web service call XML request string.(Inherited from WebServiceCall.) | 
|  | GeneratePlainTextRequest | Generates a plain-text XML request string for UpdateCheck calls(Overrides WebServiceCallGeneratePlainTextRequest.) | 
|  | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | 
|  | GetType | Gets the Type of the current instance.(Inherited from Object.) | 
|  | MemberwiseClone | Creates a shallow copy of the current Object.(Inherited from Object.) | 
|  | ProcessResponse(String) | Processes a web service response XML string.(Inherited from WebServiceCall.) | 
|  | ProcessResponse(XmlNode) | Processes a response XmlNode(Overrides WebServiceCallProcessResponse(XmlNode).) | 
|  | ResetSessionCode | Sets the SessionCode value to a new, randomized value.(Inherited from WebServiceCall.) | 
|  | ToString | (Inherited from Object.) | 
|  | ValidateWebServiceResponseFormat | Verifies the format of the response received is such that expected and required content can be found and parsed.(Inherited from WebServiceCall.) | 
 Remarks
RemarksThe XmlLicenseService documentation should be referenced for the most current information.
|  Caution | 
|---|
| Please refer to the SOLO Server manual for details on configuring product updates. | 
|  Note | 
|---|
| Before calling the CallWebService method, the LicenseID, CurrentVersion, and ProductUpdateName properties must be set. The Password, ProductID, LanguageCode, and VerifyLicenseExpirationDate properties may optionally be set before calling the CallWebService method. | 
 Examples
Examplespublic bool CheckForUpdates(int licenseID) { UpdateCheck updateChecker = new UpdateCheck(); updateChecker.LicenseID = licenseID; //Optional if the ProductID property is set. updateChecker.ProductID = 12345; //Optional if the LicenseID property is set. TODO: Remove or update this line to your ProductID assigned in SOLO Server! updateChecker.CurrentVersion = "1.2.3.4"; //TODO: Update this line to use your application's version number! updateChecker.ProductUpdateName = "XYZ Product"; //TODO: Update this line of code to use the Product Update Name configured in SOLO Server! if (!updateChecker.CallWebService()) { //TODO: check the LastError property and add error reporting here! return false; } if (updateChecker.ActionToTake != UpdateCheck.UpdateAction.None) { //TODO: Add your update logic here! } return true; }
 See Also
See Also