Skip to content

Add Go examples for message updates, deletes, and appends #3351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lmars wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Go examples for message updates, deletes, and appends #3351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions src/pages/docs/messages/updates-deletes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,31 @@ operation = MessageOperation(description="reason for update")
result = await channel.update_message(message, operation)
print("Message updated")
```

```go
realtime, err := ably.NewRealtime(ably.WithKey("{{API_KEY}}"))
if err != nil {
panic(err)
}
// This assumes there is an 'updates' namespace with a rule enabling updates and deletes
channel := realtime.Channels.Get("updates:example")

// Publish the original message and get its serial from the result
result, err := channel.PublishWithResult(context.Background(), "message-name", "original-data")
if err != nil {
panic(err)
}

// Publish an update using the serial
msg := &ably.Message{
Serial: *result.Serial,
Data: "updated-data",
}
_, err = channel.UpdateMessage(context.Background(), msg, ably.UpdateWithDescription("reason for update"))
if err != nil {
panic(err)
}
```
</Code>

#### Returns
Expand Down Expand Up @@ -399,6 +424,31 @@ operation = MessageOperation(description="reason for delete")
result = await channel.delete_message(message, operation)
print("Message deleted")
```

```go
realtime, err := ably.NewRealtime(ably.WithKey("{{API_KEY}}"))
if err != nil {
panic(err)
}
// This assumes there is an 'updates' namespace with a rule enabling updates and deletes
channel := realtime.Channels.Get("updates:example")

// Publish the original message and get its serial from the result
result, err := channel.PublishWithResult(context.Background(), "message-name", "original-data")
if err != nil {
panic(err)
}

// Delete the message using the serial
msg := &ably.Message{
Serial: *result.Serial,
Data: "", // clear the previous data
}
_, err = channel.DeleteMessage(context.Background(), msg, ably.UpdateWithDescription("reason for delete"))
if err != nil {
panic(err)
}
```
</Code>

#### Returns
Expand Down Expand Up @@ -608,6 +658,35 @@ channel.publish([.init(name: "message-name", data: "Hello")]) { result, error in
}
}
```

```go
realtime, err := ably.NewRealtime(ably.WithKey("{{API_KEY}}"))
if err != nil {
panic(err)
}
// This assumes there is an 'updates' namespace with a rule enabling updates and deletes
channel := realtime.Channels.Get("updates:example")

// Publish the original message and get its serial from the result
result, err := channel.PublishWithResult(context.Background(), "message-name", "Hello")
if err != nil {
panic(err)
}

// Append to the message a few times (without needing to await each to finish
// before doing the next); the data will be concatenated
for _, fragment := range []string{", ", "World", "!"} {
err := channel.AppendMessageAsync(&ably.Message{
Serial: *result.Serial,
Data: fragment,
}, nil)
Copy link
Copy Markdown
Contributor

@m-hulbert m-hulbert May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My Go admittedly isn't the best, but this fails when I test it - according to Claude because:

The crash is at realtime_channel.go:908 where the SDK does:

  onAck(result, nil)

  …unconditionally, with no nil check.  When the server ACKs the append, the SDK invokes that nil function — segfault.

if err != nil {
panic(err)
}
}

// the message in history now has data: "Hello, World!"
```
</Code>

#### Returns
Expand Down Expand Up @@ -734,6 +813,23 @@ serial = "0123456789-001@abcdefghij:001"

message = await channel.get_message(serial)
```

```go
rest, err := ably.NewREST(ably.WithKey("{{API_KEY}}"))
if err != nil {
panic(err)
}
channel := rest.Channels.Get("updates:example")

// Example serial; for example from the `serial` property of a `Message` you previously received
serial := "0123456789-001@abcdefghij:001"

message, err := channel.GetMessage(context.Background(), serial)
if err != nil {
panic(err)
}
_ = message
```
</Code>

## Get message versions <a id="versions"/>
Expand Down Expand Up @@ -800,6 +896,24 @@ serial = "0123456789-001@abcdefghij:001"
page = await channel.getMessageVersions(serial)
print("Found " + len(page.items) + " versions");
```

```go
rest, err := ably.NewREST(ably.WithKey("{{API_KEY}}"))
if err != nil {
panic(err)
}
channel := rest.Channels.Get("updates:example")

// Example serial; for example from the `serial` property of a `Message` you previously received
serial := "0123456789-001@abcdefghij:001"

pages := channel.GetMessageVersions(serial, nil)
page, err := pages.Next(context.Background())
if err != nil {
panic(err)
}
fmt.Printf("Found %d versions\n", len(page.Items))
```
Comment on lines +910 to +916
Copy link
Copy Markdown
Contributor

@m-hulbert m-hulbert May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to use the version below because HistoryRequest has no direct Next.

  pages, err := channel.GetMessageVersions(serial, nil).Pages(context.Background())
  if err != nil {
      panic(err)
  }
  for pages.Next(context.Background()) {
      items := pages.Items()
      fmt.Printf("Found %d versions on this page\n", len(items))
      for _, msg := range items {
          fmt.Printf("  %s: %v\n", msg.Serial, msg.Data)
      }
  }
  if err := pages.Err(); err != nil {
      panic(err)
  }

</Code>

## Message version structure <a id="version-structure"/>
Expand Down