Send an EventOut to the channel.

import Channel exposing (EventOut(..))
import Ports.Phoenix as Phx


-- Join a Channel


Phx.sendMessage
  |> Channel.send
    (Join
      { topic = "topic:subtopic"
      , timeout = Nothing
      , payload = Nothing
      }
    )


-- Push some data to a Channel


import Json.Encode as JE


Phx.sendMessage
  |> Channel.send
    (Push
      { topic = Just "topic:subtopic"
      , event = "send_msg"
      , timeout = Nothing
      , data =
          JE.object
            [ ("msg", "Hello to everyone!" |> JE.string) ]
      }

All of the events you can send to the channel.

Each of these EventOut messages corresponds to the equivalent function in the PhoenixJS API. For more info on these please read the API docs.

A type alias representing the settings for joining a channel.

topic - the channel topic id, for example: "topic:subtopic".

timeout - optional timeout, in ms, before retrying to join if the previous attempt failed.

payload - optional data to be sent to the channel when joining.

A type alias representing the settings for pushing messages over a channel.

topic - the channel topic id, for example: Just "topic:subtopic".

The topic is used to track the channels on the JS side. This allows for utilising multiple channels. Setting topic = Nothing will send the push over the last used channel, or the only channel you're using if using only one channel.

event - the event to send to the channel.

timeout - optional timeout, in ms, before retrying to push if the previous attempt failed.

payload - the data to be sent.

A type alias representing channel events that can be turned On or Off.

topic - optional channel topic id, for example: Just "topic:subtopic".

The topic is used to track the channels on the JS side. This allows for utilising multiple channels. Setting topic = Nothing will set the event on the last used channel, or the only channel you're using if using only one channel.

event - the event that you want to be turned On or Off.

In order to receive event Messages, they need to be registered with an On event sent to the channel. So if your Phoenix Channel is going to push or broadcast a new_msg event, it needs to be registered as follows:

import Channel
import Ports.Phoenix as Phx


Phx.sendMessage
    |> Channel.send
        (On
            { topic = Just "topic:subtopic"
            , event = "new_msg"
            }
        )

Now you will be able to receive new_msgs as follows:

import Channel exposing (EventIn(..))
import Ports.Phoenix as Phx


type Msg
    = ChannelMsg Channel.EventIn


update : Msg -> Model -> (Model, Cmd Msg)
update msg model =
    case msg of
        ChannelMsg (Message "topic:subtopic" "new_msg" payload) ->
            ...


subscriptions : Model -> Sub Msg
subscriptions _ =
    Phx.channelReceiver
        |> Channel.subscriptions
            ChannelMsg

NB you must set your On events after you have joined the relevant channel.

A type alias representing the settings for leaving a channel.

topic - optional channel topic id, for example: Just "topic:subtopic".

The topic is used to track the channels on the JS side. This allows for utilising multiple channels. Setting topic = Nothing will leave the last used channel, or the only channel you're using if using only one channel.

timeout - optional timeout, in ms, before retrying to leave if the previous attempt failed.

A type alias representing the port function required to send the EventOut to the channel.

You could write this yourself, if you do, it needs to be named sendMessage, although you may find it simpler to just add this port module to your src - it includes all the necessary port functions.

A type alias representing the data sent out through a port to a channel. You will not use this directly.

Subscribe to receive incoming channel events.

import Channel
import Ports.Phoenix as Phx


type Msg
  = ChannelMsg Channel.EventIn
  | ...




subscriptions : Model -> Sub Msg
subscriptions _ =
    Phx.channelReceiver
      |> Channel.subscriptions
        ChannelMsg

All of the events you can receive from the channel.

If you are using more than one channel, then you can check Topic to determine which channel the EventIn relates to. If you are only using a single channel, you can ignore Topic.

InvalidEvent means that an event has been received from the accompanying JS that cannot be handled. This should not happen, if it does, please raise an issue.

A type alias representing the channel topic. Use this to identify the channel an EventIn relates to.

If you are only using one channel, you can ignore this.

A type alias representing a Push to a channel. Use this to identify which Push an EventIn relates to.

A type alias representing the port function required to receive the EventIn from the channel.

You could write this yourself, if you do, it needs to be named channelReceiver, although you may find it simpler to just add this port module to your src - it includes all the necessary port functions.

A type alias representing the data received from a channel. You will not use this directly.