docs(apple): Add Hints API documentation - #19319
Open
itaybre wants to merge 1 commit into
Open
Conversation
Document the new Hints API for sentry-cocoa (9.28.0+), including beforeSendWithHint and beforeBreadcrumbWithHint callbacks, hint properties, custom hint values, and passing hints to capture methods. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BvkWRXpuQwgPK4mF59yssq
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
philprime
approved these changes
Sep 10, 2026
|
|
||
| #### Event Hints | ||
|
|
||
| The `beforeSendWithHint` callback is passed both the `event` and a second argument, `hint`, that holds one or more hints. |
Member
There was a problem hiding this comment.
m: We should mention that beforeSendWitHint is called instead of beforeSend if configured
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Add documentation for the new Hints API in sentry-cocoa (9.28.0+). This follows the same structure used by other SDKs (Go, JS, Python) for documenting hints.
beforeSendWithHint/beforeBreadcrumbWithHintexamplesbefore-send-hint/apple.mdxandbreadcrumb-hints/apple.mdxplatform includesbeforeSendWithHintandbeforeBreadcrumbWithHintto the options pageIS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
🤖 Generated with Claude Code
https://claude.ai/code/session_01BvkWRXpuQwgPK4mF59yssq