OKSDK.REST.call

Сигнатура метода

Метод предназначен для вызова REST API-методов OK API.

OKSDK.REST.call(methodName, methodParams, onResult)

Где:

  • methodName - название вызываемого метода, строка. Например, “users.getCurrentUser”;
  • methodParam - список параметров метода, объект. Например:
var methodParams = {
    "fields": "user.id, user.name"
}
  • onResult - callback-функция, вызываемая после получения ответа от API.

Callback

Callback-функция имеет следующую сигнатуру:

function onResult(status, data, error)

Где:

  • status - общий статус выполнения метода, строка. Возможные значения: “error”, “ok”;
  • data - результат выполнения метода, объект произвольного формат (см. ответ метода в описании каждого метода). Непустой, если status - ok;
  • error - информация об ошибке, произошедей при вызове метода, объект. Непустой, если status - error. Имеет следующую структуру:
    • error_code - код ошибки, число;
    • error_msg - текстовое описание описание ошибки, строка;
    • error_data - дополнительная информация об ошибке, строка

Пример вызова

OKSDK.REST.call(
    "users.getCurrentUser", 
    {"fields": "user.id, user.name"}, 
    function (status, data, error) {
        if (status == "ok") {
            console.log("UID: " + data.uid);
        }
       
        if (status == "error") {
            console.log("Error: " + JSON.stringify(error));
        }
    }
);