A type alias representing the Channel topic id. For example "topic:subTopic".

A type alias representing an event sent to, or received from a Channel.

A type alias representing data that is sent to, or received from, a Channel.

A type alias representing the config for joining a Channel.

• topic - The Channel topic id, for example: "topic:subtopic".

• events - A list of events to receive on the Channel.

• payload - Data to be sent to the Channel when joining. If no data is required, set this to Json.Encode.null.

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

A helper function for creating a JoinConfig.

import Phoenix.Channel exposing (joinConfig)


{ joinConfig
| topic = "topic:subTopic"
, events = [ "event1", "event2" ]
}

A type alias representing the port function required to send messages out to the accompanying JS.

You will find this port function in the Port module.

Join a Channel.

import Json.Encode as JE
import Phoenix.Channel as Channel
import Ports.Phoenix as Ports


Channel.join
    { topic = "topic:subtopic"
    , payload = JE.null
    , events = []
    , timeout = Nothing
    }
    Ports.phoenixSend

A type alias representing the config for leaving a Channel.

• topic - The Channel topic id, for example: "topic:subtopic".

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

Leave a Channel.

import Phoenix.Channel as Channel
import Ports.Phoenix as Ports


Channel.leave
    { topic = "topic:subtopic"
    , timeout = Nothing
    }
    Ports.phoenixSend

Push to a Channel.

The optional ref is returned with the response to the Push so that you can use it to identify the response later on if needed.

import Json.Encode as JE
import Phoenix.Channel as Channel
import Ports.Phoenix as Port


Channel.push
    { topic = "topic:subtopic"
    , event = "new_msg"
    , payload =
        JE.object
            [("msg", JE.string "Hello World")]
    , timeout = Nothing
    , ref = Nothing
    }
    Port.pheonixSend

A type alias representing the port function required to receive a Msg from a Channel.

You will find this port function in the Port module.

An InternalError should never happen, but if it does, it is because the JS is out of sync with this package.

If you ever receive this message, please raise an issue.

All of the messages you can receive from the Channel.

• Topic - The Channel Topic that the message came from.

• Event - The original Event that was pushed to the Channel.

• Payload - The data received from the Channel, with the exception of JoinTimout and PushTimeout where it will be the original payload.

Subscribe to receive incoming Channel Msgs.

import Phoenix.Channel as Channel
import Ports.Phoenix as Port


type Msg
  = ChannelMsg Channel.Msg
  | ...




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

Switch an incoming event on.

Switch a list of incoming events on.

Switch an incoming event off.

Switch a list of incoming events off.