Click or drag to resize
CheckoutSession Class
NetworkFloatingServiceCall implementation for checking a session out for offline use, which may later be checked back in by a CheckinSession call.
Inheritance Hierarchy

Namespace: com.softwarekey.Client.WebService.XmlNetworkFloatingService
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.23.4.0
Syntax
public class CheckoutSession : NetworkFloatingServiceCall

The CheckoutSession type exposes the following members.

Constructors
  NameDescription
Public methodCheckoutSession(AuthorEncryptionKey)
Creates a new CheckoutSession object.
Public methodCheckoutSession(XmlNetworkFloatingService, AuthorEncryptionKey)
Creates a new CheckoutSession object.
Top
Properties
  NameDescription
Public propertyActivationData
Gets or sets the XmlDocument of SystemIdentifier information to bind the NetworkSession to a specific computer. This document may be generated using the SystemIdentifier.GenerateActivationDataXml method.
(Inherited from NetworkFloatingServiceCall.)
Public propertyAlwaysIncludeCertificatePath
Gets or sets whether the certificate path is always include in requests even when the session is not checked-out..
(Inherited from NetworkFloatingServiceCall.)
Public propertyCertificate
Gets the NetworkSessionCertificate object returned from the web service.
(Inherited from NetworkFloatingServiceCall.)
Public propertyCertificateDocument
Gets the certificate XmlDocument obtained from processing a web service response.
(Inherited from NetworkFloatingServiceCall.)
Public propertyCertificatePath
Gets or sets the absolute path to the NetworkSessionCertificate file.
(Inherited from NetworkFloatingServiceCall.)
Public propertyClassName
Gets or sets the class name of the WebServiceClient object.
(Inherited from WebServiceCall.)
Public propertyComputerName
Gets or sets the Computer Name. This value is optional.
(Inherited from NetworkFloatingServiceCall.)
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 propertyLastError
Gets or sets the last error which occurred.
(Inherited from WebServiceCall.)
Public propertyLicenseID
Gets or sets the License ID issued in SOLO Server.
(Inherited from NetworkFloatingServiceCall.)
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. This may be set to the activation password assigned to the license, or the customer password, in SOLO Server.
(Inherited from NetworkFloatingServiceCall.)
Public propertyRequestedCheckoutDuration
Gets or sets the requested checkout duration (in hours) for check-out requests.
(Inherited from NetworkFloatingServiceCall.)
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 propertySessionID
Gets or sets the Session ID issued by SOLO Server (used in NetworkSession).
(Inherited from NetworkFloatingServiceCall.)
Public propertyUseDigitalSignature
Gets or sets whether or not a digital signature is to be used or is required for the web service call. (This can only be set to false if UseEncryption is already set to false.)
(Inherited from WebServiceCall.)
Public propertyUseEncryption
Gets or sets whether or not encryption is to be used or is required for the web service call.
(Inherited from WebServiceCall.)
Public propertyWebServiceClient
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.)
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
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGenerateEncryptedRequest
Generates an encrypted web service call XML request string.
(Inherited from WebServiceCall.)
Public methodGeneratePlainTextRequest
Generates a plain-text request for a call to the XmlNetworkFloatingService web service
(Inherited from NetworkFloatingServiceCall.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProcessResponse(String)
Processes a web service response XML string.
(Inherited from WebServiceCall.)
Public methodProcessResponse(XmlNode)
Processes a response from the XmlNetworkFloatingService web service and returns true if successful
(Inherited from NetworkFloatingServiceCall.)
Public methodResetSessionCode
Sets the SessionCode value to a new, randomized value.
(Inherited from WebServiceCall.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidateWebServiceResponseFormat
Verifies the format of the response received is such that expected and required content can be found and parsed.
(Inherited from WebServiceCall.)
Top
Remarks
Caution note Caution

Unless a custom implementation is required, the NetworkSession.CheckoutSession method should be used instead.

Caution note Caution

The following properties must be set before calling the CallWebService method.

See Also