[SDK-3289] Update miscellaneous references and code snippets for Swift SDK #5235

jerielng · 2023-04-12T16:15:29Z

Pull Request/Issue Resolution

Description of Change:

These changes include updates for the Swift SDK that are outside the Swift SDK platform integration guide, particularly with

SDK Authentication (Preview Link)
Device Allowlist Configuration (Preview Link)

Closes #ISSUE_NUMBER_HERE

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

Yes (12/15/2022)
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 @KellieHawks 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.
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 @KellieHawks 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
@KellieHawks	Currents Internal Tools Product Partnerships SMS Customer Lifecycle, Identity and Permissions
@bre-fitzgerald	Reporting Intelligence User Targeting IAM Channels FIX
@lydia-xie	Ingestion Core Objects Core Messaging Messaging and Automation Email (Composition and Infrastructure)

vercel · 2023-04-12T16:15:35Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
braze-docs-en	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 20, 2023 7:02pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
braze-docs-fr	⬜️ Ignored (Inspect)			Apr 20, 2023 7:02pm

jerielng · 2023-04-12T16:53:16Z

_docs/_developer_guide/platform_wide/sdk_authentication.md

@@ -293,30 +292,44 @@ Braze.getInstance(this).subscribeToSdkAuthenticationFailures({ error: BrazeSdkAu
 ```
 {% endtab %}
 {% tab Objective-C %}
+
+{% alert important %}
+Starting in version `5.14.0` of the Braze Swift SDK, the SDK authentication delegate method has been split from the `BrazeDelegate` into a separate `BrazeSDKAuthDelegate`.


This change is pending release, so we'll need to coincide this merge with the release of the new version.

@jerielng Do you know the time frame of the release?

It'll be within the next week. We have most of the changes ready, just doing some final merges and reviews.

jerielng · 2023-04-12T16:57:02Z

_docs/_developer_guide/platform_wide/sdk_authentication.md

@@ -77,7 +77,7 @@ To learn more about JSON Web Tokens, or to browse the many open source libraries

 This feature is available as of the following [SDK versions]({{ site.baseurl }}/user_guide/engagement_tools/campaigns/ideas_and_strategies/new_features/#filtering-by-most-recent-app-versions):

-{% sdk_min_versions web:3.3.0 ios:4.3.0 android:14.0.0 %}
+{% sdk_min_versions web:3.3.0 ios:5.0.1 android:14.0.0 %}


This linking seems to be broken for some reason. I'm not sure what's going on here.

Maybe @josh-mccrowell-braze can take a look

One complication is that this feature is supported on:

AppboyKit 4.3.0+

Swift SDK 5.0.1+

Since this is removing our public docs for AppboyKit, I'm debating if we are OK with:

Completely removing AppboyKit docs

Removing AppboyKit docs but linking out to the sample AppboyKit code integration

Keeping a copy of both AppboyKit docs and Swift SDK docs

I'm leaning towards 2) where at the bottom of the ObjC and Swift sections we link out to the sample code in Stopwatch, even though it's in ObjC. This would be relevant for Enable this feature in the Braze SDK and Register a callback function for invalid tokens sections:

For the legacy AppboyKit SDK, reference [this file]({file_here}) for sample code.

_docs/_developer_guide/platform_integration_guides/sdk_primer.md

hokstuff

Looks good overall - just one main point about having some links to the old AppboyKit SDK Auth integration

_docs/_developer_guide/platform_integration_guides/sdk_primer.md

hokstuff · 2023-04-12T18:46:11Z

_docs/_developer_guide/platform_wide/sdk_authentication.md

@@ -77,7 +77,7 @@ To learn more about JSON Web Tokens, or to browse the many open source libraries

 This feature is available as of the following [SDK versions]({{ site.baseurl }}/user_guide/engagement_tools/campaigns/ideas_and_strategies/new_features/#filtering-by-most-recent-app-versions):

-{% sdk_min_versions web:3.3.0 ios:4.3.0 android:14.0.0 %}
+{% sdk_min_versions web:3.3.0 ios:5.0.1 android:14.0.0 %}


Maybe @josh-mccrowell-braze can take a look

hokstuff · 2023-04-12T18:54:00Z

_docs/_developer_guide/platform_wide/sdk_authentication.md

@@ -77,7 +77,7 @@ To learn more about JSON Web Tokens, or to browse the many open source libraries

 This feature is available as of the following [SDK versions]({{ site.baseurl }}/user_guide/engagement_tools/campaigns/ideas_and_strategies/new_features/#filtering-by-most-recent-app-versions):

-{% sdk_min_versions web:3.3.0 ios:4.3.0 android:14.0.0 %}
+{% sdk_min_versions web:3.3.0 ios:5.0.1 android:14.0.0 %}


One complication is that this feature is supported on:

AppboyKit 4.3.0+

Swift SDK 5.0.1+

Since this is removing our public docs for AppboyKit, I'm debating if we are OK with:

Completely removing AppboyKit docs

Removing AppboyKit docs but linking out to the sample AppboyKit code integration

Keeping a copy of both AppboyKit docs and Swift SDK docs

I'm leaning towards 2) where at the bottom of the ObjC and Swift sections we link out to the sample code in Stopwatch, even though it's in ObjC. This would be relevant for Enable this feature in the Braze SDK and Register a callback function for invalid tokens sections:

For the legacy AppboyKit SDK, reference [this file]({file_here}) for sample code.

hokstuff · 2023-04-12T18:58:14Z

_docs/_developer_guide/platform_integration_guides/sdk_primer.md

@@ -58,23 +58,24 @@ These properties are collected by the Android SDK upon proper integration.
 {: .reset-td-br-1 .reset-td-br-2}


This file is named _docs/_developer_guide/platform_integration_guides/sdk_primer.md but the title on top is SDK 101 and the content doesn't mention push primers - do we want to rename this file (+ possible redirects) @josh-mccrowell-braze?

Hmm. The only thing that the name of the file affects (that I know of, anyway) is the URL, which is sort of low-value compared to the article title and nav title. Does the need to update the URL outweigh the risks? There's a few instances of this here and there and I generally think the update is low value.

Is there any concern with updating the name of the file (does it break anything)? I think if it's easy and doesn't interfere with anything, it might be fine to just update the file name so it doesn't stay confusing in the future

Oh, I realize now that we've talked about this that the reason this is displaying this way (although the file name is still the same) is because the feature branch is outdated. That article has gotten some TLC in the meantime.

I think it's fair to change the name of the file, and will take a note to do so, but will implement on another branch.

lowip

LGTM after the changes related to AppboyKit

jerielng · 2023-04-14T18:53:27Z

@braze-inc/sdks-web Sanity checking here, is this code snippet correct? Noticed inside the closure, it's referencing appboy.setSdkAuthenticationSignature(updated_jwt);

import * as braze from"@braze/web-sdk";
braze.subscribeToSdkAuthenticationFailures((error) => {
  // TODO: Optionally log to your error-reporting service
  // TODO: Check if the `user_id` within the `error` matches the currently logged-in user
  const updated_jwt = await getNewTokenSomehow(error);
  appboy.setSdkAuthenticationSignature(updated_jwt);
});

jerielng · 2023-04-14T18:56:42Z

@braze-inc/sdks-android Sanity check for the Java and Kotlin tabs for this section here. Seems to be referencing appboy.changeUser and pointing to this documentation link. Should these be updated?

_docs/_developer_guide/platform_wide/sdk_authentication.md

hokstuff · 2023-04-18T22:41:57Z

_docs/_developer_guide/platform_wide/sdk_authentication.md

+                                        endpoint: "{YOUR-BRAZE-ENDPOINT}")
+configuration.api.sdkAuthentication = true
+let braze = Braze(configuration: configuration)
+AppDelegate.braze = braze
 ```


Bump for this comment about including a way to access the example code for AppboyKit if they are using the legacy SDK

I included it here at the top-level instead of at each code snippet - let me know what you think!

josh-mccrowell-braze · 2023-04-19T22:31:49Z

Just FYI, re: the sdk_min_version not linking correctly, that has been fixed here: #5262

_docs/_developer_guide/platform_wide/sdk_authentication.md

Co-authored-by: Daniel Hok <4797040+hokstuff@users.noreply.github.com>

Update device allowlist documentation

3f90a28

cla-bot bot added the cla-signed label Apr 12, 2023

vercel bot deployed to Preview – braze-docs-en April 12, 2023 16:16 View deployment

jerielng force-pushed the feature/sdk-3289-swift-misc branch from b334633 to 0a43b07 Compare April 12, 2023 16:38

vercel bot deployed to Preview – braze-docs-en April 12, 2023 16:40 View deployment

jerielng added 2 commits April 12, 2023 12:47

Update SDK authentication documentation for Swift

8f8cc47

Add deprecation of SDK Authentication method in Swift SDK

56cf033

jerielng force-pushed the feature/sdk-3289-swift-misc branch from 0a43b07 to 56cf033 Compare April 12, 2023 16:52

jerielng commented Apr 12, 2023

View reviewed changes

vercel bot deployed to Preview – braze-docs-en April 12, 2023 16:54 View deployment

jerielng commented Apr 12, 2023

View reviewed changes

_docs/_developer_guide/platform_integration_guides/sdk_primer.md Show resolved Hide resolved

Fix broken link

2181b70

vercel bot deployed to Preview – braze-docs-en April 12, 2023 17:08 View deployment

jerielng changed the title ~~[WIP][SDK-3289] Update miscellaneous references and code snippets for Swift SDK~~ [SDK-3289] Update miscellaneous references and code snippets for Swift SDK Apr 12, 2023

jerielng requested review from cbowns, lowip, hokstuff, jocelynzz, josh-mccrowell-braze and nigelfaustino April 12, 2023 17:12

jerielng marked this pull request as ready for review April 12, 2023 17:16

hokstuff reviewed Apr 12, 2023

View reviewed changes

lowip approved these changes Apr 12, 2023

View reviewed changes

vercel bot deployed to Preview – braze-docs-en April 14, 2023 18:25 View deployment

Add note about AppboyKit integration

d4d0a00

jerielng force-pushed the feature/sdk-3289-swift-misc branch from 33d7394 to d4d0a00 Compare April 14, 2023 18:30

Apply suggestions from code review

9472348

vercel bot deployed to Preview – braze-docs-en April 14, 2023 18:37 View deployment

cbowns approved these changes Apr 18, 2023

View reviewed changes

_docs/_developer_guide/platform_wide/sdk_authentication.md Outdated Show resolved Hide resolved

hokstuff reviewed Apr 18, 2023

View reviewed changes

Update _docs/_developer_guide/platform_wide/sdk_authentication.md

1fb6908

vercel bot deployed to Preview – braze-docs-en April 20, 2023 13:52 View deployment

hokstuff approved these changes Apr 20, 2023

View reviewed changes

_docs/_developer_guide/platform_wide/sdk_authentication.md Outdated Show resolved Hide resolved

josh-mccrowell-braze approved these changes Apr 20, 2023

View reviewed changes

Update _docs/_developer_guide/platform_wide/sdk_authentication.md

057a7d3

Co-authored-by: Daniel Hok <4797040+hokstuff@users.noreply.github.com>

vercel bot deployed to Preview – braze-docs-en April 20, 2023 19:01 View deployment

josh-mccrowell-braze merged commit 3153737 into feature/swift-sdk-docs-epic Apr 20, 2023

josh-mccrowell-braze deleted the feature/sdk-3289-swift-misc branch April 20, 2023 19:04

jerielng mentioned this pull request May 12, 2023

Re-add miscellaneous Swift docs #5414

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SDK-3289] Update miscellaneous references and code snippets for Swift SDK #5235

[SDK-3289] Update miscellaneous references and code snippets for Swift SDK #5235

jerielng commented Apr 12, 2023 •

edited

Loading

vercel bot commented Apr 12, 2023 •

edited

Loading

jerielng Apr 12, 2023

josh-mccrowell-braze Apr 12, 2023

jerielng Apr 12, 2023

jerielng Apr 12, 2023

hokstuff Apr 12, 2023

hokstuff Apr 12, 2023

hokstuff left a comment

hokstuff Apr 12, 2023

hokstuff Apr 12, 2023

hokstuff Apr 12, 2023

josh-mccrowell-braze Apr 12, 2023

hokstuff Apr 18, 2023

josh-mccrowell-braze Apr 19, 2023

lowip left a comment

jerielng commented Apr 14, 2023

jerielng commented Apr 14, 2023

hokstuff Apr 18, 2023

jerielng Apr 19, 2023

josh-mccrowell-braze commented Apr 19, 2023

		@@ -58,23 +58,24 @@ These properties are collected by the Android SDK upon proper integration.
		{: .reset-td-br-1 .reset-td-br-2}

[SDK-3289] Update miscellaneous references and code snippets for Swift SDK #5235

[SDK-3289] Update miscellaneous references and code snippets for Swift SDK #5235

Conversation

jerielng commented Apr 12, 2023 • edited Loading

Pull Request/Issue Resolution

Description of Change:

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

vercel bot commented Apr 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hokstuff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lowip left a comment

Choose a reason for hiding this comment

jerielng commented Apr 14, 2023

jerielng commented Apr 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josh-mccrowell-braze commented Apr 19, 2023

jerielng commented Apr 12, 2023 •

edited

Loading

vercel bot commented Apr 12, 2023 •

edited

Loading