Merge pull request #901 from Iterable/feature/SDK-550-disable-device-all-users

feat(SDK-550): expose disableDeviceForAllUsers on the RN SDK

Author: jferrao-itrbl

CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased
+
+### Updates
+
+- Added `Iterable.disableDeviceForAllUsers()` to unregister this device's push token from every user associated with the device (SDK-550).
+  - iOS: forwards to native `IterableAPI.disableDeviceForAllUsers()`.
+  - Android: graceful no-op that logs a warning; use `disableDeviceForCurrentUser()` to disable push for the current user. There is no public native "all users" equivalent.
+
 ## 3.1.0
 
 ### Fixes

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java

@@ -373,6 +373,10 @@ public void disableDeviceForCurrentUser() {
         IterableApi.getInstance().disablePush();
     }
 
+    public void disableDeviceForAllUsers() {
+        IterableLogger.w(TAG, "disableDeviceForAllUsers is not supported on Android; use disableDeviceForCurrentUser. There is no public native equivalent.");
+    }
+
     public void registerDeviceToken(String token) {
         IterableLogger.v(TAG, "registerDeviceToken");
         IterableApi.getInstance().registerDeviceToken(token);

android/src/newarch/java/com/RNIterableAPIModule.java

@@ -137,6 +137,11 @@ public void disableDeviceForCurrentUser() {
     moduleImpl.disableDeviceForCurrentUser();
   }
 
+  @Override
+  public void disableDeviceForAllUsers() {
+    moduleImpl.disableDeviceForAllUsers();
+  }
+
   @Override
   public void registerDeviceToken(String token) {
     moduleImpl.registerDeviceToken(token);

android/src/oldarch/java/com/RNIterableAPIModule.java

@@ -138,6 +138,11 @@ public void disableDeviceForCurrentUser() {
       moduleImpl.disableDeviceForCurrentUser();
     }
 
+    @ReactMethod
+    public void disableDeviceForAllUsers() {
+      moduleImpl.disableDeviceForAllUsers();
+    }
+
     @ReactMethod
     public void registerDeviceToken(String token) {
       moduleImpl.registerDeviceToken(token);

ios/RNIterableAPI/RNIterableAPI.mm

@@ -230,6 +230,10 @@ - (void)disableDeviceForCurrentUser {
   [_swiftAPI disableDeviceForCurrentUser];
 }
 
+- (void)disableDeviceForAllUsers {
+  [_swiftAPI disableDeviceForAllUsers];
+}
+
 - (void)registerDeviceToken:(NSString *)token {
   [_swiftAPI registerDeviceToken:token];
 }
@@ -516,6 +520,10 @@ - (void)wakeApp {
   [_swiftAPI disableDeviceForCurrentUser];
 }
 
+RCT_EXPORT_METHOD(disableDeviceForAllUsers) {
+  [_swiftAPI disableDeviceForAllUsers];
+}
+
 RCT_EXPORT_METHOD(registerDeviceToken : (NSString *)token) {
   [_swiftAPI registerDeviceToken:token];
 }

ios/RNIterableAPI/ReactIterableAPI.swift

@@ -144,6 +144,12 @@ import React
     IterableAPI.disableDeviceForCurrentUser()
   }
 
+  @objc(disableDeviceForAllUsers)
+  public func disableDeviceForAllUsers() {
+    ITBInfo()
+    IterableAPI.disableDeviceForAllUsers()
+  }
+
   @objc(registerDeviceToken:)
   public func registerDeviceToken(token: String) {
     ITBInfo()

src/__mocks__/MockRNIterableAPI.ts

@@ -34,6 +34,8 @@ export class MockRNIterableAPI {
 
   static disableDeviceForCurrentUser = jest.fn();
 
+  static disableDeviceForAllUsers = jest.fn();
+
   static registerDeviceToken = jest.fn((token: string): void => {
     MockRNIterableAPI.token = token;
   });

src/api/NativeRNIterableAPI.ts

@@ -147,6 +147,7 @@ export interface Spec extends TurboModule {
 
   // Device management
   disableDeviceForCurrentUser(): void;
+  disableDeviceForAllUsers(): void;
   registerDeviceToken(token: string): void;
   getLastPushPayload(): Promise<{
     [key: string]: string | number | boolean;

src/core/classes/Iterable.test.ts

@@ -143,6 +143,16 @@ describe('Iterable', () => {
     });
   });
 
+  describe('disableDeviceForAllUsers', () => {
+    it('should disable the device for all users', () => {
+      // GIVEN no parameters
+      // WHEN Iterable.disableDeviceForAllUsers is called
+      Iterable.disableDeviceForAllUsers();
+      // THEN corresponding method is called on RNIterableAPI
+      expect(MockRNIterableAPI.disableDeviceForAllUsers).toBeCalled();
+    });
+  });
+
   describe('registerDeviceToken', () => {
     it('should register the device token for the current user', () => {
       // GIVEN a device token

src/core/classes/Iterable.ts

@@ -345,6 +345,27 @@ export class Iterable {
     IterableApi.disableDeviceForCurrentUser();
   }
 
+  /**
+   * Disable this device's push token for every user associated with the device,
+   * not only the currently signed-in user.
+   *
+   * On iOS this forwards to native `IterableAPI.disableDeviceForAllUsers()`.
+   * On Android this is a no-op that logs a warning in Metro and logcat: the
+   * native Android SDK has no public "all users" equivalent. Use
+   * {@link disableDeviceForCurrentUser} to disable push for the current user
+   * on both platforms. The native Android method is still invoked.
+   *
+   * Fire-and-forget: native success or failure is not surfaced to JS.
+   *
+   * @example
+   * ```typescript
+   * Iterable.disableDeviceForAllUsers();
+   * ```
+   */
+  static disableDeviceForAllUsers() {
+    IterableApi.disableDeviceForAllUsers();
+  }
+
   /**
    * Register the device's token for the current user, re-enabling push notifications.
    *