diff --git a/.changeset/pretty-swans-kneel.md b/.changeset/pretty-swans-kneel.md new file mode 100644 index 0000000000..9919d72507 --- /dev/null +++ b/.changeset/pretty-swans-kneel.md @@ -0,0 +1,5 @@ +--- +'livekit-client': patch +--- + +Deprecate backwards incompatible chat message fields diff --git a/src/room/types.ts b/src/room/types.ts index 9536eeaeda..5153b5258e 100644 --- a/src/room/types.ts +++ b/src/room/types.ts @@ -19,6 +19,7 @@ export interface SendTextOptions { topic?: string; // replyToMessageId?: string; destinationIdentities?: Array; + /** @deprecated Use the Data Streams API instead: https://docs.livekit.io/transport/data/byte-streams/ */ attachments?: Array; onProgress?: (progress: number) => void; attributes?: Record; @@ -115,7 +116,9 @@ export interface ChatMessage { id: string; timestamp: number; message: string; + /** @deprecated No longer recommended, use the Text Streams API instead: https://docs.livekit.io/transport/data/text-streams/ */ editTimestamp?: number; + /** @deprecated Use the Data Streams API instead: https://docs.livekit.io/transport/data/byte-streams/ */ attachedFiles?: Array; }