Click or drag to resize
UpdateCheck Class
Implements the XmlLicenseService web service's UpdateCheck method to check for product or application updates.
Inheritance Hierarchy
SystemObject
  com.softwarekey.Client.WebServiceWebServiceCall
    com.softwarekey.Client.WebService.XmlLicenseServiceUpdateCheck

Namespace: com.softwarekey.Client.WebService.XmlLicenseService
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.17.4.0
Syntax
public class UpdateCheck : WebServiceCall

The UpdateCheck type exposes the following members.

Constructors
  NameDescription
Public methodUpdateCheck
Creates a new UpdateCheck object.
Public methodUpdateCheck(XmlLicenseService)
Creates a new UpdateCheck object with a specified web service client (XmlLicenseService) object.
Top
Properties
  NameDescription
Public propertyActionToTake
Gets which action should be taken, as indicated by SOLO Server's response.
Public propertyClassName
Gets or sets the class name of the WebServiceClient object.
(Inherited from WebServiceCall.)
Public propertyCurrentVersion
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.
Public propertyDownloadUrl
Gets the URL where the new file/update, or information on how to download the new file(s)/update(s), may be found.
Public propertyEncryptionKey
Gets or sets the author encryption key data.
(Inherited from WebServiceCall.)
Public propertyErrorMessage
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.)
Public propertyInformationUrl
Gets the URL where more information about the available update may be found.
Public propertyLanguageCode
Gets or sets the language code of the message to retrieve. (The default is "en", for U.S. English.)
Public propertyLastError
Gets or sets the last error which occurred.
(Inherited from WebServiceCall.)
Public propertyLatestVersion
Gets the latest, free version available.
Public propertyLicenseID
Gets or sets the License ID of the activated license.
Public propertyLicenseStatus
Gets the status of the SOLO Server License ID.
Public propertyLicenseUpdate
Gets a small, arbitrary string which may be used for customized status updates.
Public propertyMethodName
Gets or sets the name of the method which will be called from the WebServiceClient object.
(Inherited from WebServiceCall.)
Public propertyPassword
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.
Public propertyProductID
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.
Public propertyProductUpdateName
Gets or sets the product update name to search for in SOLO Server.
Public propertyReleaseDate
Gets the date in which the LatestVersion was released.
Public propertyReplacedBy
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.
Public propertyRequireSsl
Gets or sets whether or not SSL certificate validation to check.
(Inherited from WebServiceCall.)
Public propertyResultCode
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.)
Public propertySessionCode
Gets or sets the randomized session code (used to deter replay attacks).
(Inherited from WebServiceCall.)
Public propertySessionCodeValidation
Gets or sets whether or not session code validation should be done automatically.
(Inherited from WebServiceCall.)
Public propertyShortMessage
Gets a short, HTML-formatted message, which may be displayed to the user.
Public propertyUseDigitalSignature
Overrides the UseDigitalSignature property to reflect the fact that this web service method does not support digital signatures.
(Overrides WebServiceCallUseDigitalSignature.)
Public propertyUseEncryption
Overrides the UseEncryption property to reflect the fact that this web service method does not support encryption.
(Overrides WebServiceCallUseEncryption.)
Public propertyVerifyLicenseExpirationDate
Gets or sets whether or not the License ID's expiration date will be validated. (The default value is false.)
Public propertyWebServiceClient
Gets or sets the SoapHttpClientProtocol object used to perform the web service method call.
(Inherited from WebServiceCall.)
Public propertyWebServiceResponse
Gets or set the XmlNode object reference for the root XML node of the web service response.
(Inherited from WebServiceCall.)
Top
Methods
  NameDescription
Protected methodAppendSessionCode(String)
Appends the SessionCode value to an XML request string depending on the SessionCodeValidation setting, and returns the updated XML string
(Inherited from WebServiceCall.)
Protected methodAppendSessionCode(XmlDocument)
Appends the SessionCode value to an XmlDocument depending on the SessionCodeValidation setting, and returns the updated XML string
(Inherited from WebServiceCall.)
Public methodCallWebService
Calls the web service method.
(Inherited from WebServiceCall.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGenerateEncryptedRequest
Generates an encrypted web service call XML request string.
(Inherited from WebServiceCall.)
Public methodGeneratePlainTextRequest
Generates a plain-text XML request string for UpdateCheck calls
(Overrides WebServiceCallGeneratePlainTextRequest.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodProcessResponse(String)
Processes a web service response XML string.
(Inherited from WebServiceCall.)
Public methodProcessResponse(XmlNode)
Processes a response XmlNode
(Overrides WebServiceCallProcessResponse(XmlNode).)
Public methodResetSessionCode
Sets the SessionCode value to a new, randomized value.
(Inherited from WebServiceCall.)
Public methodToString (Inherited from Object.)
Top
Remarks

The XmlLicenseService documentation should be referenced for the most current information.

Caution note Caution

Please refer to the SOLO Server manual for details on configuring product updates.

Examples
This example shows how to make a typical UpdateCheck call:
public 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