Metoda aquireApplicationLock
Umożliwia zablokowanie aplikacji dla innych użytkowników.
boolean aquireApplicationLock(string session_id, string message, boolean stealLock)
Blokada aplikacji jest ustawiana na 5 minut. Po tym czasie, każdy administrator odzyska dostęp do zasobów aplikacji
Parametry wejściowe
- session_id (string) - identyfikator sesji użytkownika
- message (string) - wiadomość wyświetlana innym zalogowanym użytkownikom jako powód blokady
- stealLock (bool) - czy wymusić blokadę aplikacji mimo istniejącej blokady innego użytkownika
Wartość zwracana
- result (bool) - zawsze true po udanej próbie założenia blokady
Rzucane wyjątki SoapFault
- W przypadku nieprawidłowego identyfikatora sesji lub nagłego usunięcia użytkownika, rzucany jest wyjątek z komunikatem Permission denied i kodem błędu 2
- W przypadku występowania blokady aplikacji i gdy parametr stealLock ustawiony jest na false, rzucany jest wyjątek z komunikatem Cannot aquire Exclusive lock. Lock is set by another user
Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)
Przykład wywołania w PHP
<?php /** * Logowanie do API * * @param resource $c cURL resource handle * @param string $login Login użytkownika * @param string $password Hasło użytkownika * @return string Indentyfikatorr sesji użytkownika */ function login($c, $login, $password) { $params = Array( "method" => "login", "params" => Array($login, $password) ); curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params)); $result = (Array)json_decode(curl_exec($c)); if (isset($result['error'])) { return null; } else { return $result[0]; } } $c = curl_init(); curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/'); curl_setopt($c, CURLOPT_POST, true); curl_setopt($c, CURLOPT_RETURNTRANSFER, 1); // zalogowanie użytkownika i pobranie identyfikatora sesji $session = login($c, "api", "test"); if ($session != null) { $params = Array( "method" => "aquireApplicationLock", "params" => Array($session, "Panel administracyjny został zablokowany.", false) ); // zakodowanie parametrów dla metody POST $postParams = "json=" . json_encode($params); curl_setopt($c, CURLOPT_POSTFIELDS, $postParams); // dekodowanie rezultatu w formacie JSON do tablicy result $data = curl_exec($c); $result = (Array)json_decode($data); // sprawdzenie, czy wystąpił błąd if (isset($result['error'])) { echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code']; } else { if ($result[0] == 1) { echo "Aplikacja została zablokowana"; } else { echo "Aplikacja nie została zablokowana"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>