From 3ca1f97e4070bf782d7360dcc9341e95767454d8 Mon Sep 17 00:00:00 2001 From: Qolzam Date: Fri, 14 Jul 2017 11:54:43 +0430 Subject: [PATCH] Improve authorizationAction.jsx description --- docs/layers/actions.md | 48 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/docs/layers/actions.md b/docs/layers/actions.md index 9daca98..bae6148 100644 --- a/docs/layers/actions.md +++ b/docs/layers/actions.md @@ -6,8 +6,52 @@ This layer is responsible for implementing actions for entities. [Actions](http: We provide some actions to authorize a user. The authorize actions include singup, login, logout and update password for a user. -#### Functions +### Functions + ```jsx dbLogin = (email, password) => {} ``` -This action check a user by email and password to authorize a user to login website. \ No newline at end of file + +This action check a user by `email` and `password` to authorize a user to login website. + +```jsx +dbLogout = () => {} +``` + +This action is responsible to logout the user. + +```jsx +dbSignup = (user) => {} +``` + +This action is responsible to register user on the server. `user` parameter is a user object with user information. + +```jsx +dbUpdatePassword = (newPassword) => {} +``` + +This action is responsible to change user passwaord on the server. `newPassword` parameter is the password that user wants to replace with current password. + +```jsx +login = (uid) => {} +``` + +This action is responsible to change user state to login state on reducer. `uid` is the user identifire. + +```jsx +logout = () => {} +``` + +This action is responsible to change user state to logout state on reducer. + +```jsx +signup = (user) => {} +``` + +This action is responsible to create new user state on reducer. + +```jsx +updatePassword = () => {} +``` + +This action is responsible to fire reducer method on update password. \ No newline at end of file