ZDK
Public Member Functions | List of all members
ZDK::IActivationResult Class Referenceabstract

Activation process result. More...

#include <IActivationResult.h>

Inheritance diagram for ZDK::IActivationResult:
ZDK::IZHandle

Public Member Functions

virtual ZDK::ActivationStatus Status () const =0
 Activation process status result. More...
 
virtual ZDK::Shared::String Reason () const =0
 Text representation of the reason for the activation status. More...
 
virtual ZDK::Shared::String Certificate () const =0
 The certificate returned by the activation server in case of successful activation. More...
 
virtual ZDK::Shared::String Build () const =0
 The build type returned by the activation server in case of successful activation. More...
 
virtual ZDK::Shared::String HddSerial () const =0
 The HDD serial number associated with this activation returned by the activation server. More...
 
virtual ZDK::Shared::String Mac () const =0
 The MAC address associated with this activation returned by the activation server. More...
 
virtual ZDK::Shared::String Checksum () const =0
 The checksum of the ZDK library returned by the activation server. More...
 
- Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle Handle () const =0
 
virtual operator ZDK::ZDKHandle () const =0
 
virtual void Initialize ()=0
 
virtual void ReleaseReference ()=0
 

Detailed Description

Activation process result.

This structior is filled and fired in IContextEventsHandler OnContextActivationCompleted() only if the activation process has completed unambiguously. This means that we have reached the server successfully and got a proper result, be it successful or not.

This means that in case of an error, it is a final error and not a temporary error. No timeouts or other temporary errors will result in filling this structure and reception of OnContextActivationCompleted(). Temporary errors will lead to the library retrying gracefully until a unambiguous result is obtained.

The activation process will retry until it gets a proper response from the server.

The result from the server can be either "Success" followed by the rest fields filled in or any kind of error and and Reason() and all the rest fields being empty.

See also
IContextEventsHandler, OnContextActivationCompleted()

Member Function Documentation

◆ Build()

virtual ZDK::Shared::String ZDK::IActivationResult::Build ( ) const
pure virtual

The build type returned by the activation server in case of successful activation.

In case of failure it can be either empty string or even null pointer!

Returns
The activation build type

◆ Certificate()

virtual ZDK::Shared::String ZDK::IActivationResult::Certificate ( ) const
pure virtual

The certificate returned by the activation server in case of successful activation.

In case of failure it can be either empty string or even null pointer!

Returns
The activation certificate

◆ Checksum()

virtual ZDK::Shared::String ZDK::IActivationResult::Checksum ( ) const
pure virtual

The checksum of the ZDK library returned by the activation server.

In case of failure it can be either empty string or even null pointer!

Returns
The ZDK's library checksum

◆ HddSerial()

virtual ZDK::Shared::String ZDK::IActivationResult::HddSerial ( ) const
pure virtual

The HDD serial number associated with this activation returned by the activation server.

In case of failure it can be either empty string or even null pointer!

Returns
The HDD serial number

◆ Mac()

virtual ZDK::Shared::String ZDK::IActivationResult::Mac ( ) const
pure virtual

The MAC address associated with this activation returned by the activation server.

In case of failure it can be either empty string or even null pointer!

Returns
The MAC address

◆ Reason()

virtual ZDK::Shared::String ZDK::IActivationResult::Reason ( ) const
pure virtual

Text representation of the reason for the activation status.

Explains the meaning of the activation status result.

Returns
Description of the activation process status result
See also
Status()

◆ Status()

virtual ZDK::ActivationStatus ZDK::IActivationResult::Status ( ) const
pure virtual

Activation process status result.

Represents the activation process starus result - "Success" or the type of failure.

Returns
The activation process status
See also
ActivationStatus

The documentation for this class was generated from the following file: