Coherence
v0.8.0

Redirects behaviour (Coherence v0.8.0)

Define controller action redirection behaviour.

Defines the default redirect functions for each of the controller actions that perform redirects. By using this Module you get the following functions:

  • session_create/2
  • session_delete/2
  • password_create/2
  • password_update/2,
  • unlock_create_not_locked/2
  • unlock_create_invalid/2
  • unlock_create/2
  • unlock_edit_not_locked/2
  • unlock_edit/2
  • unlock_edit_invalid/2
  • registration_create/2
  • registration_delete/2
  • invitation_create/2
  • invitation_resend/2
  • confirmation_create/2
  • confirmation_edit_invalid/2
  • confirmation_edit_expired/2
  • confirmation_edit/2
  • confirmation_edit_error/2

You can override any of the functions to customize the redirect path. Each function is passed the conn and params arguments from the controller.

Examples 

use Redirects
import MyProject.Router.Helpers

# override the log out action back to the log in page
def session_delete(conn, _), do: redirect(conn, to: session_path(conn, :new))

# redirect the user to the login page after registering
def registration_create(conn, _), do: redirect(conn, to: session_path(conn, :new))

# disable the user_return_to feature on login
def session_create(conn, _), do: redirect(conn, to: landing_path(conn, :index))

Summary

Callbacks

confirmation_create(conn, params)
confirmation_edit(conn, params)
confirmation_edit_error(conn, params)
confirmation_edit_expired(conn, params)
confirmation_edit_invalid(conn, params)
invitation_create(conn, params)
invitation_resend(conn, params)
password_create(conn, params)
password_update(conn, params)
registration_create(conn, params)
registration_delete(conn, params)
registration_update(conn, params, user)
session_create(conn, params)
session_delete(conn, params)
unlock_create(conn, params)
unlock_create_invalid(conn, params)
unlock_create_not_locked(conn, params)
unlock_edit(conn, params)
unlock_edit_invalid(conn, params)
unlock_edit_not_locked(conn, params)

Callbacks

Link to this callback

confirmation_create(conn, params)

@callback confirmation_create(conn :: term(), params :: term()) :: term()
Link to this callback

confirmation_edit(conn, params)

@callback confirmation_edit(conn :: term(), params :: term()) :: term()
Link to this callback

confirmation_edit_error(conn, params)

@callback confirmation_edit_error(conn :: term(), params :: term()) :: term()
Link to this callback

confirmation_edit_expired(conn, params)

@callback confirmation_edit_expired(conn :: term(), params :: term()) :: term()
Link to this callback

confirmation_edit_invalid(conn, params)

@callback confirmation_edit_invalid(conn :: term(), params :: term()) :: term()
Link to this callback

invitation_create(conn, params)

@callback invitation_create(conn :: term(), params :: term()) :: term()
Link to this callback

invitation_resend(conn, params)

@callback invitation_resend(conn :: term(), params :: term()) :: term()
Link to this callback

password_create(conn, params)

@callback password_create(conn :: term(), params :: term()) :: term()
Link to this callback

password_update(conn, params)

@callback password_update(conn :: term(), params :: term()) :: term()
Link to this callback

registration_create(conn, params)

@callback registration_create(conn :: term(), params :: term()) :: term()
Link to this callback

registration_delete(conn, params)

@callback registration_delete(conn :: term(), params :: term()) :: term()
Link to this callback

registration_update(conn, params, user)

@callback registration_update(conn :: term(), params :: term(), user :: term()) :: term()
Link to this callback

session_create(conn, params)

@callback session_create(conn :: term(), params :: term()) :: term()
Link to this callback

session_delete(conn, params)

@callback session_delete(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_create(conn, params)

@callback unlock_create(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_create_invalid(conn, params)

@callback unlock_create_invalid(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_create_not_locked(conn, params)

@callback unlock_create_not_locked(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_edit(conn, params)

@callback unlock_edit(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_edit_invalid(conn, params)

@callback unlock_edit_invalid(conn :: term(), params :: term()) :: term()
Link to this callback

unlock_edit_not_locked(conn, params)

@callback unlock_edit_not_locked(conn :: term(), params :: term()) :: term()