Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
All the methods associated with the socket channels
All the events associated with the socket channels
After phoenix channel is left. The following redux event is dispatched
import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_LEAVE } = channelActionTypes;type
CHANNEL_LEAVE
channel
Phoenix channel
After joining a phoenix channel, the following redux event is dispatched.
import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_JOIN } = channelActionTypes;type
CHANNEL_JOIN
channel
Phoenix channel
additionalData
additionalData passed when using
response
Phoenix channel response
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
import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_CLOSE } = channelActionTypes;type
CHANNEL_CLOSE
channel
Phoenix channel
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;type
CHANNEL_TIMEOUT
channelTopic
Name of channel/Topic
channel
Phoenix channel
additionalData
additionalData passed when using getPhoenixChannel
error
Phoenix channel error
channelTopic
Name of channel/Topic
string
event
Event name to unsubscribe to
string
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;type
CHANNEL_ERROR
channelTopic
Name of channel/Topic
channel
Phoenix channel
channelTopic
Name of channel/Topic
string
events
Array of event names to unsubscribe to
string []
Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after joining the phoenix channel.
import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_JOIN_ERROR } = channelActionTypes;type
CHANNEL_JOIN_ERROR
channelTopic
Name of channel/Topic
channel
Phoenix channel
additionalData
additionalData passed when using getPhoenixChannel
error
Phoenix channel error
channelTopic
Name of channel/Topic
string
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.
events
Array of event names to subscribe to and will dispatch response to eventActionType
{
eventName:string; eventActionType:string
} []
domainUrl
socket endpoint to connect to
string
channelTopic
Name of channel/Topic
string
logPresence
Determines if presence should be tracked for the channel
boolean
token
private token for channel
string
additionalData
This data will be available for you as additionalData on the response
object
This method will attempt to find the subscribed phoenix channel for the given channelTopic and push data to the channel for the eventName.
import { pushPhoenixChannel } from '@trixtateam/phoenix-to-redux';Recommended that you already have made a socket connection by using connectPhoenix method before using this method.
additionalData
This data will be available for you as additionalData on the response
object
loadingStatusKey
A unique identifier you can use to separate progress status
string
endProgressDelay
timeout in milliseconds if you want to delay the endProgress of your loadingStatusKey
number
channelResponseEvent
name of redux event to dispatch to reducer on response from pushing to channel
string
channelErrorResponseEvent
name of redux event to dispatch to reducer on error from pushing to channel
string
channelTimeOutEvent
name of redux event to dispatch to reducer on timeout from pushing to channel
string
dispatchChannelError
false by default, determines if should an on channel error occur dispatch to the reducer
boolean
channelPushTimeOut
timeout in milliseconds for pushing to the channel, default is 1500
number
channelTopic
Name of channel/Topic
string
eventName
Name of the event on channel to push to
string
requestData
Payload data to push on the channel
any
Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after pushing data to phoenix channel.
import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_PUSH_ERROR } = channelActionTypes;type
CHANNEL_PUSH_ERROR
channelTopic
Name of channel/Topic
channel
Phoenix channel
error
Phoenix channel error