Using the Realtime API you can create channels and channel resources where messages can be published. Site visitors who subscribe to a channel receive the messages published to that channel. When a message is received you can handle the message any way you choose, such as displaying the contents of the message or changing the state of page elements depending on the contents of the message. You can also manage the permissions of who can read from specific channels.
The wix-realtime-frontend
module is used in conjunction with the
wix-realtime-backend
module.
Get hands-on experience with the Realtime API on our Hello Realtime example page.
Typical uses of the Realtime API include implementing a messaging system or as an alternative to using a polling mechanism.
The Realtime API uses the following terminology:
For a tutorial on using the Realtime API, see Sending Messages with the Realtime API.
To use the Realtime API, import wixRealtimeFrontend
from the wix-realtime-frontend
module:
import wixRealtimeFrontend from "wix-realtime-frontend";