Sign inGet started

bird realtime apps update

Usage

Contoh kode
bird realtime apps update <realtime-app-id> [flags]

Description

Update a Realtime app
Rename a Realtime app or change its configuration flags. Omitted fields keep their current value. Region cannot be changed after creation, so moving an app to another region means creating a new one and repointing clients.
Build the request from flags, a JSON RealtimeAppUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Contoh kode
# print the body shape (no credentials needed)
bird realtime apps update --example

# the body it prints:
Contoh kode
{
  "connection_counting": true,
  "name": "chat-production"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--nameA label for the app, shown wherever it is listed.
--client-eventsAllow clients to trigger events directly (client events).
--connection-countingCount the connections subscribed to each channel and expose the count on channel queries.
--connection-count-eventsBroadcast a connection-count event to a channel's subscribers whenever its connection count changes. Requires connection_counting.
--watchlist-eventsTell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
--authorized-connectionsRequire every connection to be authorized.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird realtime apps createCreate a Realtime app
bird realtime apps deleteDelete a Realtime app
bird realtime apps getGet a Realtime app
bird realtime apps listList Realtime apps

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.

Coba praktiknya dan dapatkan ringkasan implementasi