Skip to content
This repository was archived by the owner on Jan 7, 2025. It is now read-only.

Commit 63078e3

Browse files
committed
Added new fields: action (TM2j) and serial (TM2k). Part of a bigger task (ably/ably-cocoa#2000).
1 parent dfa833c commit 63078e3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

descriptions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,21 @@ Describes the possible actions members in the presence set can emit.
592592
| LEAVE | TP2 | A member who was present has now left the channel. This may be a result of an explicit request to leave or implicitly when detaching from the channel. Alternatively, if a member's connection is abruptly disconnected and they do not resume their connection within a minute, Ably treats this as a leave event as the client is no longer present. |
593593
| UPDATE | TP2 | An already present member has updated their member data. Being notified of member data updates can be very useful, for example, it can be used to update the status of a user when they are typing a message. |
594594

595+
596+
## enum MessageAction
597+
598+
Describes the possible actions message can represent (in order from zero).
599+
600+
| Enum | Spec | Description |
601+
|---|---|---|
602+
| MESSAGE_UNSET | TM5 | Message was unset. |
603+
| MESSAGE_CREATE | TM5 | Message was created. |
604+
| MESSAGE_UPDATE | TM5 | Message was updated. |
605+
| MESSAGE_DELETE | TM5 | Message was deleted. |
606+
| ANNOTATION_CREATE | TM5 | An annotation to the message was created. |
607+
| ANNOTATION_DELETE | TM5 | An annotation to the message was deleted. |
608+
| META_OCCUPANCY | TM5 | An occupancy data. |
609+
595610
## class ConnectionDetails
596611

597612
Contains any constraints a client should adhere to and provides additional metadata about a [`Connection`]{@link Connection}, such as if a request to [`publish()`]{@link RealtimeClient#publish} a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.
@@ -636,6 +651,8 @@ Contains an individual message that is sent to, or received from, Ably.
636651
| id: String ||| TM2a | A Unique ID assigned by Ably to this message. |
637652
| name: String? ||| TM2g | The event name. |
638653
| timestamp: Time ||| TM2f | Timestamp of when the message was received by Ably, as milliseconds since the Unix epoch. |
654+
| action: MessageAction ||| TM2j | The [`MessageAction`]{@link MessageAction} this message represents. |
655+
| serial: String? ||| TM2k | An opaque string that uniquely identifies the message. |
639656

640657
## class PresenceMessage
641658

0 commit comments

Comments
 (0)