1 of 15

Channel

All the methods and events associated with the socket channels

Methods

All the methods associated with the socket channels

leavePhoenixChannel

This method will leave the phoenix channel for the given channelTopic and unsubscribes off of channel events

Parameters

Parameter

Description

Type

Required

leavePhoenixChannelEvents

This method will unsubscribe for the given events for the given channelTopic

Parameters

Parameter

Description

Type

Required

leavePhoenixChannelEvent

This method will unsubscribe for the given event for the given channelTopic

import { leavePhoenixChannelEvent } from '@trixtateam/phoenix-to-redux';

Parameters

Parameter

Description

Type

Required

getPhoenixChannel

This method will subscribe phoenix channel for the given channelTopic and given events

import { getPhoenixChannel } from '@trixtateam/phoenix-to-redux';

Recommended that you already have made a socket connection by using connectPhoenix method before using this method.

Parameters

Parameter

Description

Type

Required

pushPhoenixChannel

This method will attempt to find the subscribed phoenix channel for the given channelTopic and push data to the channel for the eventName.

Recommended that you already have made a socket connection by using method before using this method.

Parameters

Parameter

Description

Type

Required

Events

All the events associated with the socket channels

CHANNEL_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Invoked if the socket connection drops, or the channel crashes on the server.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_ERROR } = channelActionTypes;

Parameter

Description

CHANNEL_LEAVE

After phoenix channel is left. The following redux event is dispatched

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_LEAVE } = channelActionTypes;

Parameter

Description

CHANNEL_JOIN_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after joining the phoenix channel.

Parameter

Description

CHANNEL_JOIN

After joining a phoenix channel, the following redux event is dispatched.

Parameter

Description

CHANNEL_TIMEOUT

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Timeout error response after joining the phoenix channel.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_TIMEOUT } = channelActionTypes;

Parameter

Description

CHANNEL_PUSH_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after pushing data to phoenix channel.

Parameter

Description

CHANNEL_CLOSE

Should a phoenix channel be explicitly closed on the server or the channel was explicitly closed by calling channel.leave(). The following redux event is dispatched

Parameter

Description