Phoenix
v1.7.20
v1.7.19
v1.7.18
v1.7.17
v1.7.16
v1.7.15
v1.7.14
v1.7.13
v1.7.12
v1.7.11
v1.7.10
v1.7.9
v1.7.8
v1.7.7
v1.7.6
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.7.0-rc.3
v1.7.0-rc.2
v1.7.0-rc.1
v1.7.0-rc.0
v1.6.16
v1.6.15
v1.6.14
v1.6.13
v1.6.12
v1.6.11
v1.6.10
v1.6.9
v1.6.8
v1.6.7
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.6.0-rc.1
v1.6.0-rc.0
v1.5.14
v1.5.13
v1.5.12
v1.5.11
v1.5.10
v1.5.9
v1.5.8
v1.5.7
v1.5.6
v1.5.5
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.5.0-rc.0
v1.4.18
v1.4.17
v1.4.16
v1.4.15
v1.4.14
v1.4.13
v1.4.12
v1.4.11
v1.4.10
v1.4.9
v1.4.8
v1.4.7
v1.4.6
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.4.0-rc.3
v1.4.0-rc.2
v1.4.0-rc.1
v1.4.0-rc.0
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.3.0-rc.3
v1.3.0-rc.2
v1.3.0-rc.1
v1.3.0-rc.0
v1.2.5
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.2.0-rc.1
v1.2.0-rc.0
v1.1.9
v1.1.8
v1.1.7
v1.1.6
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.17.1
v0.17.0
v0.16.1
v0.16.0
v0.15.0
v0.14.0
v0.13.1
v0.13.0
v0.12.0
v0.11.0
v0.10.0
v0.9.0
v0.8.0
v0.7.2
v0.7.1
v0.7.0
v0.6.2
v0.6.1
v0.6.0
v0.5.0
GUIDES
Modules
Mix Tasks
Phoenix
Top
Summary
Functions
json_library/0
plug_init_mode/0
Phoenix.Channel
Top
Sections
Topics & Callbacks
Authorization
Incoming Events
Replies
Intercepting Outgoing Events
Broadcasting to an external topic
Terminate
Exit reasons when stopping a channel
Subscribing to external topics
Hibernation
Shutdown
Logging
Summary
Types
reply/0
socket_ref/0
Functions
broadcast/3
broadcast!/3
broadcast_from/3
broadcast_from!/3
intercept/1
push/3
reply/2
socket_ref/1
Callbacks
code_change/3
handle_call/3
handle_cast/2
handle_in/3
handle_info/2
handle_out/3
join/3
terminate/2
Phoenix.Controller
Top
Sections
Options
Connection
Plug pipeline
Controllers are plugs
Rendering and layouts
Summary
Functions
accepts/2
action_fallback/1
action_name/1
allow_jsonp/2
clear_flash/1
controller_module/1
current_path/1
current_path/2
current_url/1
current_url/2
delete_csrf_token/0
endpoint_module/1
fetch_flash/2
get_csrf_token/0
get_flash/1
get_flash/2
get_format/1
html/2
json/2
layout/1
layout_formats/1
merge_flash/2
protect_from_forgery/2
put_flash/3
put_format/2
put_layout/2
put_layout_formats/2
put_new_layout/2
put_new_view/2
put_root_layout/2
put_router_url/2
put_secure_browser_headers/2
put_static_url/2
put_view/2
redirect/2
render/2
render/3
root_layout/1
router_module/1
scrub_params/2
send_download/3
status_message_from_template/1
text/2
view_module/1
view_template/1
Phoenix.Endpoint
Top
Sections
Endpoints
Endpoint configuration
Endpoint API
Summary
Types
event/0
msg/0
topic/0
Functions
server?/2
socket/3
Callbacks
broadcast/3
broadcast!/3
broadcast_from/4
broadcast_from!/4
config/2
config_change/2
host/0
init/2
local_broadcast/3
local_broadcast_from/4
path/1
script_name/0
start_link/0
static_integrity/1
static_lookup/1
static_path/1
static_url/0
struct_url/0
url/0
Phoenix.Logger
Top
Sections
Instrumentation
Parameter filtering
Disabling
Phoenix.Naming
Top
Summary
Functions
camelize/1
camelize/2
humanize/1
resource_name/2
underscore/1
unsuffix/2
Phoenix.Param
Top
Sections
Custom parameters
Summary
Types
t/0
Functions
to_param/1
Phoenix.Presence
Top
Sections
Example Usage
Fetching Presence Information
Testing with Presence
Summary
Types
presence/0
presences/0
topic/0
Callbacks
fetch/2
get_by_key/2
list/1
track/3
track/4
untrack/2
untrack/3
update/3
update/4
Phoenix.Router
Top
Sections
Routing
Helpers
Scopes and Resources
Pipelines and plugs
Summary
Functions
connect/4
delete/4
forward/4
get/4
head/4
match/5
options/4
patch/4
pipe_through/1
pipeline/2
plug/2
post/4
put/4
resources/2
resources/3
resources/4
route_info/4
scope/2
scope/3
scope/4
scoped_alias/2
trace/4
Phoenix.Token
Top
Sections
Example
Usage
Summary
Functions
decrypt/4
encrypt/4
sign/4
verify/4
Phoenix.View
Top
Sections
Examples
Rendering
Summary
Functions
__using__/1
render/3
render_existing/3
render_layout/4
render_many/4
render_one/4
render_to_iodata/3
render_to_string/3
Testing
Phoenix.ChannelTest
Top
Sections
Channel testing
Checking side-effects
Leave and close
Summary
Functions
assert_broadcast/3
assert_push/3
assert_reply/4
broadcast_from/3
broadcast_from!/3
close/2
connect/3
join/2
join/3
join/4
leave/1
push/3
refute_broadcast/3
refute_push/3
refute_reply/4
socket/1
socket/3
subscribe_and_join/2
subscribe_and_join/3
subscribe_and_join/4
subscribe_and_join!/2
subscribe_and_join!/3
subscribe_and_join!/4
Phoenix.ConnTest
Top
Sections
Endpoint testing
Controller testing
Views testing
Recycling
Summary
Functions
assert_error_sent/2
build_conn/0
build_conn/3
bypass_through/1
bypass_through/2
bypass_through/3
clear_flash/1
connect/3
delete/3
delete_req_cookie/2
dispatch/5
ensure_recycled/1
fetch_flash/1
get/3
get_flash/1
get_flash/2
head/3
html_response/2
init_test_session/2
json_response/2
options/3
patch/3
post/3
put/3
put_flash/3
put_req_cookie/3
recycle/2
redirected_params/1
redirected_to/2
response/2
response_content_type/2
text_response/2
trace/3
Adapters and Plugs
Phoenix.CodeReloader
Top
Summary
Functions
call/2
init/1
reload!/1
Phoenix.Endpoint.Cowboy2Adapter
Top
Sections
Endpoint configuration
Custom dispatch options
Phoenix.Endpoint.CowboyAdapter
Top
Sections
Custom dispatch options
Socket and Transport
Phoenix.Socket
Top
Sections
Socket Behaviour
Examples
Socket fields
Using options
Garbage collection
Client-server communication
Custom sockets and transports
Custom channels
Summary
Types
t/0
Functions
assign/2
assign/3
channel/3
Callbacks
connect/2
connect/3
id/1
Phoenix.Socket.Broadcast
Top
Summary
Types
t/0
Phoenix.Socket.Message
Top
Summary
Types
t/0
Functions
from_map!/1
Phoenix.Socket.Reply
Top
Summary
Types
t/0
Phoenix.Socket.Serializer
Top
Summary
Callbacks
decode!/2
encode!/1
fastlane!/1
Phoenix.Socket.Transport
Top
Sections
Booting sockets
Operating sockets
Example
Security
Summary
Types
state/0
Functions
check_origin/5
check_subprotocols/2
code_reload/3
connect_info/3
force_ssl/4
transport_log/2
Callbacks
child_spec/1
connect/1
handle_control/2
handle_in/2
handle_info/2
init/1
terminate/2
Templating
Phoenix.Template
Top
Sections
Options
Terminology
Custom Template Engines
Format encoders
Summary
Types
name/0
path/0
root/0
Functions
engines/0
find_all/3
format_encoder/1
hash/3
module_to_template_root/3
template_path_to_name/2
Phoenix.Template.EExEngine
Top
Summary
Functions
compile/2
Phoenix.Template.Engine
Top
Summary
Callbacks
compile/2
Phoenix.Template.ExsEngine
Top
Summary
Functions
compile/2
Exceptions
Phoenix.ActionClauseError
Top
Summary
Functions
blame/2
message/1
Phoenix.MissingParamError
Top
Phoenix.NotAcceptableError
Top
Phoenix.Router.MalformedURIError
Top
Phoenix.Router.NoRouteError
Top
Phoenix.Socket.InvalidMessageError
Top
Phoenix.Template.UndefinedError
Top
Summary
Functions
message/1
Phoenix.Router.NoRouteError
exception
(Phoenix v1.5.5)
View Source
Exception raised when no route is found.
Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/
or
s
Focus search bar
g
Go to a HexDocs package
?
Bring up this help dialog
Go to a HexDocs package
×