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

IAM lifecycle events #977

Merged
merged 15 commits into from
Aug 30, 2021
Merged

IAM lifecycle events #977

merged 15 commits into from
Aug 30, 2021

Conversation

emawby
Copy link
Contributor

@emawby emawby commented Aug 18, 2021

This PR adds the OSInAppMessageLifecycleHandler protocol with the following lifecycle methods:

- (void)onWillDisplayInAppMessage:(OSInAppMessage *)message;
- (void)onDidDisplayInAppMessage:(OSInAppMessage *)message;
- (void)onWillDismissInAppMessage:(OSInAppMessage *)message;
- (void)onDidDismissInAppMessage:(OSInAppMessage *)message;

And adds the public setter method setInAppMessageLifecycleHandler

These methods should each be called once per display of an In App Message.

The InAppMessageDelegate was exposed in the public header with the method
- (void)handleMessageAction:(OSInAppMessageAction * _Nonnull)action
But it appears to never be called. I am leaving it in case it is erroneously being used by a consumer application.


This change is Reviewable

OSInAppMessageDelegate previously just had the handleMessageAction method, but there was no way to set the delegate and was never called.
Using this new class in our IAM Lifecycle Handler Methods
Previously migrate was only in init. This will still allow crashes due to not migrating if customers call other public methods prior to calling OneSignal initWithLaunchOptions. We should avoid this as best as possible by migrating immediately.

This implementation can be changed later to queue all methods until after init has been called so that we don't unnecessarily migrate.
@emawby emawby requested review from jkasten2 and nan-li August 18, 2021 22:25
@emawby emawby changed the title WiP IAM lifecycle events IAM lifecycle events Aug 19, 2021
Copy link
Member

@jkasten2 jkasten2 left a comment

Choose a reason for hiding this comment

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

Reviewed 28 of 28 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @emawby and @nan-li)


iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m, line 1599 at r1 (raw file):

    let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];

    OSInAppMessageInternal * message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];

nit, extra space around *.

The IAM Lifecycle Methods will now match the Android naming of OSInAppMessageLifecycleHandler.

I am leaving the unused OSInAppMessageDelegate to avoid build failures in customer systems that might erroneously be using the protocol.
@emawby emawby force-pushed the feature/IAM_lifecycle_events branch from 2800265 to 97f0ef6 Compare August 30, 2021 16:27
@emawby emawby merged commit 7673c5a into main Aug 30, 2021
@emawby emawby deleted the feature/IAM_lifecycle_events branch August 30, 2021 16:27
@emawby emawby mentioned this pull request Aug 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants