Класс Omnilance

Граф наследования:Omnilance:

Открытые члены
	__construct (string $apiKey, string $secretKey)

Открытые статические члены
static	checkDomain (string $user, string $password, string $domain, ?string &$error)
static	suggestDomain (string $user, string $password, string $word1, string $word2, array $tlds, ?string &$error)
static	createDomain (string $user, string $password, string $domain, array $params, ?string &$error)
static	renewDomain (string $user, string $password, string $domain, ?string &$error)
static	updateDns (string $user, string $password, string $domain, array $params, ?string &$error)
static	getDomainsList (string $user, string $password, ?string &$error)

Поля данных
const	BASE_ENDPOINT = 'https://api.omnilance.com/v3/'

Подробное описание

См. определение в файле omnilance.php строка 4

Конструктор(ы)

__construct()

__construct	(	string	$apiKey,
		string	$secretKey )

Omnilance constructor.

Аргументы

string	$apiKey	API key.
string	$secretKey	Secret key.

См. определение в файле omnilance.php строка 34

Методы

checkDomain()

checkDomain ( string $user, string $password, string $domain, ?string & $error )

static

Checks domain available.

Аргументы

string	$user	User name.
string	$password	User password.
string	$domain	Domain name.
string | null	&$error	Error message if occurred.

Возвращает

bool|null Returns true if domain exists.

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 96

createDomain()

createDomain ( string $user, string $password, string $domain, array $params, ?string & $error )

static

Creates new domain.

Аргументы

string	$user	User name.
string	$password	User password.
string	$domain	Domain name.
array	$params	Additional params.
string | null	&$error	Error message if occurred.

Возвращает

bool|null Returns true on success.

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 159

getDomainsList()

getDomainsList ( string $user, string $password, ?string & $error )

static

Returns domain's list.

Аргументы

string	$user	User name.
string	$password	User password.
string | null	&$error	Error message if occurred.

Возвращает

array|null

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 271

renewDomain()

renewDomain ( string $user, string $password, string $domain, ?string & $error )

static

Renews exists domain.

Аргументы

string	$user	User name.
string	$password	User password.
string	$domain	Domain name.
string | null	&$error	Error message if occurred.

Возвращает

bool|null Returns true on success.

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 192

suggestDomain()

suggestDomain ( string $user, string $password, string $word1, string $word2, array $tlds, ?string & $error )

static

Suggests domains by query words.

Аргументы

string	$user	User name.
string	$password	User password.
string	$word1	Query word 1.
string	$word2	Query word 2.
array	$tlds	Query tlds.
string | null	&$error	Error message if occurred.

Возвращает

array|null

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 144

updateDns()

updateDns ( string $user, string $password, string $domain, array $params, ?string & $error )

static

Updates domain DNS.

Аргументы

string	$user	User name.
string	$password	User password.
string	$domain	Domain name.
array	$params	Additional params.
string | null	&$error	Error message if occurred.

Возвращает

bool|null Returns true on success.

Переопределяет метод предка Registrar.

См. определение в файле omnilance.php строка 225

Поля

BASE_ENDPOINT

const BASE_ENDPOINT = 'https://api.omnilance.com/v3/'

Base endpoint url.

См. определение в файле omnilance.php строка 9

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/mail/lib/registrar/omnilance.php