Skip to content

Commit

Permalink
Features spec: update TM5 message action
Browse files Browse the repository at this point in the history
As agreed and implemented in
ably/sdk-api-reference#44 (comment) ,
which was before I merged that repo into this, so the change is already made in
api-docstrings.md but needs to be made in the features spec too

This is technically a breaking change, but probably fine to just edit in-place
(without changing the api version) since we don't yet have any public
functionality that depends on the message action, and we're not planning on
making serverside behaviour switch on api version, we're just going to make the
change and have the chat sdk (which is what needs this) depend on new enough
versions of released sdks
  • Loading branch information
SimonWoolf committed Jan 8, 2025
1 parent 268fbc4 commit 15800b0
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions textile/features.textile
Original file line number Diff line number Diff line change
Expand Up @@ -1332,7 +1332,7 @@ h3(#types). Data types

h4. Message
* @(TM1)@ A @Message@ represents an individual message to be sent or received via the Ably Realtime service.
* @(TM5)@ @Message@ @Action@ enum has the following values in order from zero: @MESSAGE_UNSET@, @MESSAGE_CREATE@, @MESSAGE_UPDATE@, @MESSAGE_DELETE@, @ANNOTATION_CREATE@, @ANNOTATION_DELETE@, @META_OCCUPANCY@
* @(TM5)@ @Message@ @Action@ enum has the following values in order from zero: @MESSAGE_CREATE@, @MESSAGE_UPDATE@, @MESSAGE_DELETE@, @META_OCCUPANCY@, @MESSAGE_SUMMARY@
* @(TM2)@ The attributes available in a @Message@ are:
** @(TM2a)@ @id@ string - unique ID for this message. This attribute is always populated for messages received over REST. For messages received over Realtime, if the message does not contain an @id@, it should be set to @protocolMsgId:index@, where @protocolMsgId@ is the id of the @ProtocolMessage@ encapsulating it, and @index@ is the index of the message inside the @messages@ array of the @ProtocolMessage@
** @(TM2b)@ @clientId@ string
Expand Down Expand Up @@ -2181,13 +2181,11 @@ enum PresenceAction: // TP2
UPDATE // TP2

enum MessageAction: // TM5
MESSAGE_UNSET // TM5
MESSAGE_CREATE // TM5
MESSAGE_UPDATE // TM5
MESSAGE_DELETE // TM5
ANNOTATION_CREATE // TM5
ANNOTATION_DELETE // TM5
META_OCCUPANCY // TM5
MESSAGE_SUMMARY // TM5

class ConnectionDetails: // CD*, internal
clientId: String? // RSA12a, CD2a
Expand Down

0 comments on commit 15800b0

Please sign in to comment.