kerio::web::ProductRegistration Interface Reference

Class provides an interface for both standard and trial registration process of Kerio products. More...

import"ProductRegistration.idl";

Public Member Functions
void	finish (in string token, in string baseId, in Registration registrationInfo, in RegistrationFinishType finishType)
void	get (out Registration registrationInfo, out boolean newRegistration, in string token, in string securityCode, in string baseId, out boolean trial)
void	getFullStatus (out RegistrationFullStatus status)
void	getStatus (out RegistrationStatus status)
void	start (out string token, out string image, out boolean showImage, in string langId)
void	verifyNumber (out ErrorList errors, out RegistrationNumberList regNumberInfo, out boolean allowFinish, out long users, out RegDate expirationDate, in string token, in string baseId, in RegStringList regNumbersToVerify)

Detailed Description

Class provides an interface for both standard and trial registration process of Kerio products.

(Trial) registration begins with calling method startRegistration(). The method returns a token (for identifying registration session) and a "security" picture. A code from the picture and the token are sent back to server as argument of method get() together with a registration number. If the reg. number already exists in the system the server sends back License details which could be displayied by the wizard. As step 3 the wizard offers a user interface for adding new registration numbers. A new number can be verified by method verifyRegistrationNumber(). The registration can be finished by method finish().

Member Function Documentation

void kerio::web::ProductRegistration::finish	(	in string	token,
		in string	baseId,
		in Registration	registrationInfo,
		in RegistrationFinishType	finishType
	)

The Method finishes registration and installs the valid licenseKey.

Parameters

token	- ID of wizard's session
baseId	- Base ID of registration
registrationInfo	- Registration data retrieved from server by getRegistrationInfo() and modified by user.
finishType	- how to finish the registration? Create a new one, modyfy an existing or just download an existing license?

void kerio::web::ProductRegistration::get	(	out Registration	registrationInfo,
		out boolean	newRegistration,
		in string	token,
		in string	securityCode,
		in string	baseId,
		out boolean	trial
	)

Retrieves existing registration data from the server.

Parameters

registrationInfo	- the registration data related to the license ID
newRegistration	- flag indicates whether the registration has already existed.
token	- ID of wizard's session
securityCode	- a code number from the security immage
baseId	- license ID
trial	- trial ID registered on web, do not display registrationInfo and finish immediatelly

void kerio::web::ProductRegistration::getFullStatus

(

out RegistrationFullStatus

status

)

The function checks what kind of registration should be offered to the user.

Parameters

status

- A current registration status of the product.

See also

RegistrationFullStatus

void kerio::web::ProductRegistration::getStatus

(

out RegistrationStatus

status

)

The function checks what kind of registration should be offered to the user.

Parameters

status

- Current registration status of the product.

See also

RegistrationStatus

void kerio::web::ProductRegistration::start	(	out string	token,
		out string	image,
		out boolean	showImage,
		in string	langId
	)

Starts registration process. Methods connect to a server and obtain an identification token and a security image.

Parameters

token	- ID of wizard's session
image	- URL of the image with the security code
showImage	- show captcha image in wizard if true
langId	- language id

void kerio::web::ProductRegistration::verifyNumber	(	out ErrorList	errors,
		out RegistrationNumberList	regNumberInfo,
		out boolean	allowFinish,
		out long	users,
		out RegDate	expirationDate,
		in string	token,
		in string	baseId,
		in RegStringList	regNumbersToVerify
	)

Function checks whether a registration number can be added to the registration with the BaseId.

It may happen that the nummber is OK, but the registration cannot be finished without adding some other registration numbers. In that case parameter allowFinish is set to false and admin must disable wizards "next" button to avoid finishing an uncomplete registration.

Parameters

errors	- description of an error in case of failure
regNumberInfo	- information related to given registration key(s)
allowFinish	- if false, the number is OK, but the registration cannot be finished without adding some other numbers.
users	- the count of users connected to the license
expirationDate	- licence expiration date
token	- ID of wizard's session
baseId	- Registration's baseId
regNumbersToVerify	- a list of numbers to be verified

---

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

• ProductRegistration.idl