@workadventure/iframe-api-typings 1.18.1 → 1.18.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/play/src/front/Api/Iframe/chat.d.ts +4 -4
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workadventure/iframe-api-typings",
3
- "version": "v1.18.1",
3
+ "version": "v1.18.2",
4
4
  "description": "Typescript typings for WorkAdventure iFrame API",
5
5
  "main": "iframe_api.js",
6
6
  "types": "iframe_api.d.ts",
package/play/src/front/Api/Iframe/chat.d.ts CHANGED
@@ -24,13 +24,13 @@ export declare class WorkadventureChatCommands extends IframeApiContribution<Wor
24
24
  */
25
25
  close(): void;
26
26
  /**
27
- * Sends a message in the chat. The message is only visible in the browser of the current user.
27
+ * Sends a message in the chat.
28
28
  * {@link https://docs.workadventu.re/developer/map-scripting/references/api-chat#sending-a-message-in-the-chat | Website documentation}
29
- * @deprecated Use the overload with "options" instead
29
+ *
30
30
  * @param {string} message Message to be displayed in the chat
31
- * @param {string|undefined} author Name displayed for the author of the message. It does not have to be a real user
31
+ * @param {SendChatMessageOptions|string|undefined} options Decides if the message is sent only to the local users or to all users in the bubble. In undefined, the message is sent to the local user only. If the message is sent locally, you can decide an "author" name to be displayed in the chat. It does not have to be a real user. If a string is passed instead of an object, it will be used as the Name displayed for the author of the message (and the message type will automatically by "local"). Using a string instead of an object is deprecated.
32
32
  */
33
- sendChatMessage(message: string, author?: string): void;
33
+ sendChatMessage(message: string, options?: string | SendChatMessageOptions): void;
34
34
  /**
35
35
  * Simulates a user is currently typing a message in the chat.
36
36
  *