Scorocode.User

Содержание

• .User
  • new User()
  • .signup(options) ⇒ promise.<sc.User>
  • .login(email, password, options) ⇒ promise.<sc.User>
  • .logout(options)

---

new User()

Класс для работы с пользователями приложения.

Пример

// Подключим SDK и инициализируем его. 
var sc = require('scorocode');
sc.Init({
    ApplicationID: "applicationId_приложения",
    JavaScriptKey: "javascriptKey_приложения"
});

// Создадим новый экземпляр sc.User
var appUser = new sc.User();
// Передадим данные, необходимые для регистрации пользователя приложения
appUser.set("email", "user@mailserver.domain").set("password", "52c7ab3dab2c").set("username", "ChosenOne");
// Зарегистрируем пользователя приложения
appUser.signup()
    // Обработчик успешного выполнения запроса
    .then((success)=>{
        // Выведем результат в консоль
        console.log(success);
    })
    // Обработчик ошибки
    .catch((error)=>{
        // Выведем результат в консоль    
        console.log(error)
    });

---

.signup(options)

Метод для регистрации пользователей приложения.

Тип: Метод sc.User

Параметр	Тип	Свойства	Описание	Пример значения
callback	Object		Коллбэки success и error для выполняемого запроса.

Пример

// Подключим SDK и инициализируем его. 
var sc = require('scorocode');
sc.Init({
    ApplicationID: "applicationId_приложения",
    JavaScriptKey: "javascriptKey_приложения"
});

// Создадим новый экземпляр sc.User
var appUser = new sc.User();
// Передадим данные, необходимые для регистрации пользователя приложения
appUser.set("email", "user@domain.zone").set("password", "CorrectHorseBatteryStaple").set("username", "ChosenOne");
// Зарегистрируем пользователя приложения
appUser.signup()
    // Обработчик успешного выполнения запроса
    .then((success)=>{
        // Выведем результат в консоль
        console.log(success);
    })
    // Обработчик ошибки
    .catch((error)=>{
        // Выведем результат в консоль    
        console.log(error)
    });

Возвращает promise.{sc.User} - возвращает promise, который возвращает данные sc.User

---

.login(email, password, options)

Метод для аутентификации пользователя приложения и получения пользовательской сессии.

Тип: instance method of User

Параметр	Тип	Свойства	Описание	Пример значения
email	String	Обязательный	Email пользователя	"user@domain.zone"
password	String	Обязательный	Пароль пользователя	"CorrectHorseBatteryStaple"
callback	Object		Коллбэки success и error для выполняемого запроса.

Пример

// Подключим SDK и инициализируем его. 
var sc = require('scorocode');
sc.Init({
    ApplicationID: "applicationId_приложения",
    JavaScriptKey: "javascriptKey_приложения"
});

// Создадим новый экземпляр sc.User
var appUser = new sc.User();
// Аутентифицируем пользователя приложения, используя его email и password
appUser.login("user@domain.zone", "CorrectHorseBatteryStaple")
    // Обработчик успешного выполнения запроса
    .then((loggedIn)=>{
        console.log("Пользователь приложения аутентифицирован: \n", loggedIn);
        // Установим время сессии - 10000 мс.
        setTimeout( function () {
            // Деаутентифицируем пользователя приложения
            appUser.logout()
                // Обработчик успешного выполнения запроса
                .then((loggedOut)=>{
                    console.log("Пользователь приложения деаутентифицирован \n");
                })
                // Обработчик ошибки
                .catch((errLogout)=>{
                    console.log(errLogout)
                });
            },10000);
    })
    // Обработчик ошибки
    .catch((errLogin)=>{
        console.log(errLogin)
    });

Возвращает promise.{sc.User} - возвращает promise, который возвращает данные sc.User

---

.logout(options)

Метод для деаутентификации пользователя приложения и удаления пользовательской сессии.

Тип: Метод sc.User

Параметр	Тип	Свойства	Описание	Пример значения
callback	Object		Коллбэки success и error для выполняемого запроса.

Пример

// Подключим SDK и инициализируем его. 
var sc = require('scorocode');
sc.Init({
    ApplicationID: "applicationId_приложения",
    JavaScriptKey: "javascriptKey_приложения",
});

// Создадим новый экземпляр sc.User
var appUser = new sc.User();
// Аутентифицируем пользователя приложения, используя его email и password
appUser.login("user@domain.zone", "CorrectHorseBatteryStaple")
    // Обработчик успешного выполнения запроса
    .then((loggedIn)=>{
        console.log("Пользователь приложения аутентифицирован: \n", loggedIn);
        // Установим время сессии - 10000 мс.
        setTimeout( function () {
            // Деаутентифицируем пользователя приложения
            appUser.logout()
                // Обработчик успешного выполнения запроса
                .then((loggedOut)=>{
                    console.log("Пользователь приложения деаутентифицирован \n");
                })
                // Обработчик ошибки
                .catch((errLogout)=>{
                    console.log(errLogout)
                });
            },10000);
    })
    // Обработчик ошибки
    .catch((errLogin)=>{
        console.log(errLogin)
    });