mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 03:15:06 +03:00
chore: Update Broadcast documentation with REST endpoint (#17789)
* chore: Update Broadcast documentation with REST endpoint Documents the usage of Broadcast with the new REST endpoint. * chore: update Realtime docs regarding Broadcast endpoint --------- Co-authored-by: Wen Bo Xie <wenbo.xie3@gmail.com>
This commit is contained in:
1 parent
cf3e0402dd
commit
4023ef2885
1 file changed
+37
-5
@@ -37,14 +37,14 @@ const channelA = clientA.channel('room-1')
|
||||
|
||||
// Simple function to log any messages we receive
|
||||
function messageReceived(payload) {
|
||||
console.log(payload)
|
||||
console.log(payload)
|
||||
}
|
||||
|
||||
// Subscribe to the Channel
|
||||
channelA
|
||||
.on(
|
||||
'broadcast',
|
||||
{ event: 'test' },
|
||||
'broadcast',
|
||||
{ event: 'test' },
|
||||
(payload) => messageReceived(payload)
|
||||
)
|
||||
.subscribe()
|
||||
@@ -93,8 +93,8 @@ const myChannel = supabase.channel('room-2', {
|
||||
})
|
||||
|
||||
myChannel.on(
|
||||
'broadcast',
|
||||
{ event: 'test-my-messages' },
|
||||
'broadcast',
|
||||
{ event: 'test-my-messages' },
|
||||
(payload) => console.log(payload)
|
||||
)
|
||||
|
||||
@@ -135,6 +135,38 @@ myChannel.subscribe(async (status) => {
|
||||
|
||||
Use this to guarantee that the server has received the message before resolving `channelD.send`'s promise. If the `ack` config is not set to `true` when creating the channel, the promise returned by `channelD.send` will resolve immediately.
|
||||
|
||||
### Send messages using REST calls
|
||||
|
||||
You can also send a Broadcast message by making an HTTP request to Reatlime servers. This is useful when you want to send messages from your server or client without having to first establish a WebSocket connection.
|
||||
|
||||
```js
|
||||
import { RealtimeClient } from '@supabase/realtime-js'
|
||||
|
||||
const client = new RealtimeClient(REALTIME_URL, {
|
||||
params: {
|
||||
apikey: API_KEY,
|
||||
},
|
||||
})
|
||||
|
||||
const channel = client.channel('test-channel')
|
||||
|
||||
// No need to subscribe to channel
|
||||
|
||||
channel
|
||||
.send({
|
||||
type: 'broadcast',
|
||||
event: 'test',
|
||||
payload: { message: 'Hi' },
|
||||
})
|
||||
.then((resp) => {
|
||||
console.log(resp)
|
||||
})
|
||||
|
||||
// Remember to clean up the channel
|
||||
|
||||
client.removeChannel(channel)
|
||||
```
|
||||
|
||||
export const Page = ({ children }) => <Layout meta={meta} children={children} />
|
||||
|
||||
export default Page
|
||||
Reference in new issue
Block a user