Skip to content
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.

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

[SDK Untracked] Clarify subscribeToSessionUpdates behavior #7473

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

jacksonemiller
Copy link
Contributor

@jacksonemiller jacksonemiller commented Jun 5, 2024

Pull Request/Issue Resolution

Description of Change:

Follow up to this GitHub issue.

Is this change associated with a Braze feature/product release?

  • Yes (Insert Feature Release Date Here)
  • No

✔️ Pull Request Checklist
  • Check that you haven't removed any images (replacing an image with an updated one of the same name is fine), as this breaks the French site
  • Check that all links work.
  • Ensure you have completed our Contributors License Agreement.
  • Tag @josh-mccrowell-braze and @internetisaiah as a reviewer when your work is done and ready to be reviewed for merge. Are you an internal product manager? Reference the internal reviewing chart to tag the appropriate reviewer.
  • If the documentation involves a 1) paid SKU, 2) a third party, 3) SMS, 4) AI, or 5) privacy, ensure that Ana Teresa Serafino on the Legal team has signed off.
  • Tag others as reviewers as necessary.
  • If you have modified any links, be sure to add redirects to assets > js > broken_redirect_list.js
⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
  • Read our Reviewing a PR page for more on our reviewing suggestions.
  • Read our Previewing Documentation page to see how to check the deployment.
    • Preview all changes in the linked Vercel environment by clicking the preview link in the vercel-bot comment in your PR.
❗ ATTN: Internal Reviewing Chart
Work at Braze and not sure who to tag for review?
Before tagging @josh-mccrowell-braze or @internetisaiah for a general review, reference the following chart to see if a specific product vertical/reviewer applies to your pull request.

Reviewer Product Vertical
@josh-mccrowell-braze Monolith Deployments
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
@internetisaiah Developer Guide
Technology partners
Channels
@bre-fitzgerald Intelligence
In-App Messages
Channels
Frontend Infrastructure & Experience (FIX)
@lydia-xie Ingestion
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
@rachel-feinberg Customer Lifecycle, Identity and Permissions
SMS
User Targeting
Reporting

@@ -71,7 +71,7 @@ App-specific details will display only if the user has used more than one app.

## Subscribing to session updates

To listen to session updates, use the [`subscribeToSessionUpdates(_:)`][1] method:
To listen to session updates, use the [`subscribeToSessionUpdates(_:)`][1] method. Session start and end events will only be logged when the app is running in the foreground. If you register a callback to session end events and the app is backgrounded, the callback will fire when the app is foregrounded again.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also add that the time attached to the session end event corresponds to the last time the app was closed/backgrounded?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To be clear, you mean the duration of the session, right? The time of the event will still be the time that the app is foregrounded again, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, sorry that's right. The time for both events will be at foreground, but it's the duration of the session that this would refer to.

Copy link
Contributor

@jerielng jerielng left a comment

Choose a reason for hiding this comment

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

LGTM

@internetisaiah internetisaiah self-assigned this Jun 6, 2024
@internetisaiah
Copy link
Contributor

Hey @jacksonemiller , let me know when this one's ready for a tech writer review!

@josh-mccrowell-braze
Copy link
Collaborator

Hey @jacksonemiller : Just checking in about the status of this PR. Thanks!

@jacksonemiller
Copy link
Contributor Author

@josh-mccrowell-braze Hey, sorry for leaving this open for so long with no updates. We had a team discussion about it last week. I'll update it today and then get reviews from my team before opening it up for yalls review.

@josh-mccrowell-braze
Copy link
Collaborator

@jacksonemiller No worries! Just wanted to make sure it doesn't go stale. Thanks!

Copy link
Contributor

@hokstuff hokstuff left a comment

Choose a reason for hiding this comment

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

This SGTM to describe today's behavior. If we do make an update in the future, we can just update this again

@jacksonemiller
Copy link
Contributor Author

@internetisaiah This is now ready for a review, my team has okay-ed it.

Copy link
Collaborator

@josh-mccrowell-braze josh-mccrowell-braze left a comment

Choose a reason for hiding this comment

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

Thanks for this!

@josh-mccrowell-braze josh-mccrowell-braze merged commit c585488 into develop Jul 1, 2024
3 checks passed
@josh-mccrowell-braze josh-mccrowell-braze deleted the sdk-session-end-documentation branch July 1, 2024 15:40
@lydia-xie lydia-xie mentioned this pull request Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants