vkreq v0.0.1 VKReq.Callback

This is example callback module for VKReq plug

Summary

Functions

The function is being called when request is verified to be invalid VK request This can happen for 2 reasons and one of 2 error values will be given to the function:

  • :hash_mismatch - request’s “auth_key” param (hash) is invalid
  • :required_params_missing - request doesn’t have minimally required params to perform a validation One of possible use-cases for the function is user signin-or-signup

The function is being called when request is verified to be VK request One of possible use-cases for the function is user signin-or-signup

Functions

on_error(conn, error)

Specs

on_error(Plug.Conn.t, :hash_mismatch | :required_params_missing) :: Plug.Conn.t

The function is being called when request is verified to be invalid VK request This can happen for 2 reasons and one of 2 error values will be given to the function:

  • :hash_mismatch - request’s “auth_key” param (hash) is invalid
  • :required_params_missing - request doesn’t have minimally required params to perform a validation One of possible use-cases for the function is user signin-or-signup
on_success(conn)

Specs

on_success(Plug.Conn.t) :: Plug.Conn.t

The function is being called when request is verified to be VK request One of possible use-cases for the function is user signin-or-signup