webadmin::Domains Interface Reference

Public Member Functions
void	get (out DomainList list, out long totalItems, in kerio::web::SearchQuery query)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in DomainList domains)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList domainIds, in Domain pattern)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList domainIds)
void	testDomainController (out kerio::web::ErrorList errors, in kerio::web::StringList hostnames, in DirectoryServiceConfiguration directory)
void	apply (out kerio::web::ErrorList errors)
void	reset ()

Member Function Documentation

void webadmin::Domains::apply

(

out kerio::web::ErrorList

errors

)

write changes cached in manager to configuration

Parameters

errors

- list of errors 8001 Invalid params. - "Unable to add/modify domain %1, wrong parameters." 8002 Database error. - "Unable to add/modify domain %1." 8002 Database error. - "Unable to delete the domain."

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in DomainList	domains
	)

Add new domain

Parameters

errors	- list of errors 1001 Already exists. - "Domain %1 already exists." 8001 Invalid params. - "Unable to add/modify domain %1, wrong parameters."
result	- list of IDs assigned to each item
domains	- details for new domains. field id is assigned by the manager to temporary value until apply() or reset().

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::get	(	out DomainList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain list of domains

Parameters

list	- list of domains and it's details
totalItems	- count of all domains on server (before the start/limit applied)
query	- conditions and limits

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	domainIds
	)

Delete domains

Parameters

errors	- list of errors 8001 Invalid params. - "Unable to remove the local domain." 8002 Database error. - "Unable to delete the domain."
domainIds	- ids of domains that should be removed

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::reset

(

)

discard changes cached in manager

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	domainIds,
		in Domain	pattern
	)

Update domains' details

Parameters

errors	- list of errors 1001 Already exists. - "Domain %1 already exists." 8001 Invalid params. - "Error: multiple primary domains." 8001 Invalid params. - "Unable to add/modify domain %1, wrong parameters."
domainIds	- ids of domains to be updated.
pattern	- details for update. Field "kerio::web::KId" is ignored. All other fields except password must be filled and they are written to all domains specified by domainIds.

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::Domains::testDomainController	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	hostnames,
		in DirectoryServiceConfiguration	directory
	)

Test of domain accessibility

Parameters

errors	- Various error messages related to given data, indexed by values in "hostnames" parameter, contains leading '.'
hostnames	- List of servers, that will be used instead of servers in DirectoryService. Empty string means, that server should be autodetected
directory	- domain parameters for connection test

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 8001 Invalid params. - "Unable to read the stored password."

Note

: Members useSpecificServers, primaryServer and secondaryServer from DirectoryService are not used in this method

---

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

• Domains.idl