zdk.objc
Instance Methods | Properties | List of all members
<ZDKActivationResult> Protocol Reference

Activation process result. More...

#import <ZDKActivationResult.h>

Inheritance diagram for <ZDKActivationResult>:
<ZDKZHandle>

Instance Methods

(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

ZDKActivationStatus status
 Activation process status result. More...
 
NSString * reason
 Text representation of the reason for the activation status. More...
 
NSString *_Nullable certificate
 The certificate returned by the activation server in case of successful activation. More...
 
NSString *_Nullable build
 The build type returned by the activation server in case of successful activation. More...
 
NSString *_Nullable hddSerial
 The HDD serial number associated with this activation returned by the activation server. More...
 
NSString *_Nullable mac
 The MAC address associated with this activation returned by the activation server. More...
 
NSString *_Nullable checksum
 The checksum of the ZDK library returned by the activation server. More...
 

Detailed Description

Activation process result.

This structior is filled and fired in ZDKContextEventsHandler 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
ZDKContextEventsHandler, onContextActivationCompleted()

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

Property Documentation

◆ build

- (NSString* _Nullable) build
readnonatomicassign

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

- (NSString* _Nullable) certificate
readnonatomicassign

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

- (NSString* _Nullable) checksum
readnonatomicassign

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

- (NSString* _Nullable) hddSerial
readnonatomicassign

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

- (NSString* _Nullable) mac
readnonatomicassign

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

- (NSString*) reason
readnonatomicassign

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

- (ZDKActivationStatus) status
readnonatomicassign

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 protocol was generated from the following file: