Skip to content

feat(kits): split LogoutListener from AttributeListener #683

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.

Sign up for GitHub

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

Closed
denischilik wants to merge 2 commits into from
Closed

feat(kits): split LogoutListener from AttributeListener #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09bfee2
feat: split LogoutListener from AttributeListener
denischilik Mar 27, 2026
ed12758
Simplify code
denischilik Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...d-kit-base/src/androidTest/kotlin/com/mparticle/kits/testkits/AttributeListenerTestKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import com.mparticle.kits.ReportingMessage

open class AttributeListenerTestKit :
ListenerTestKit(),
KitIntegration.AttributeListener {
KitIntegration.AttributeListener,
KitIntegration.LogoutListener {
var setUserAttribute: ((attributeKey: String?, attributeValue: String?) -> Unit)? = null
var setUserAttributeList: ((attributeKey: String?, attributeValueList: List<String?>?) -> Unit)? =
null
Expand Down
24 changes: 15 additions & 9 deletions android-kit-base/src/main/java/com/mparticle/kits/KitIntegration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,21 @@ public interface SessionListener {
List<ReportingMessage> onSessionEnd();
}

/**
* Kits may implement this interface to respond when the mParticle Identity API performs a logout.
*/
public interface LogoutListener {

/**
* The mParticle SDK exposes a logout API, allowing developers to track an event
* when a user logs out of their app/platform. Use this opportunity to perform the appropriate logic
* as per your platforms logout paradigm, such as clearing user attributes.
*
* @return Kits should return a List of ReportingMessages indicating that the logout was processed one or more times, or null if it was not processed
*/
List<ReportingMessage> logout();
}

/**
* Kits should implement this interface when their underlying service has the notion
* of a user with attributes.
Expand Down Expand Up @@ -374,15 +389,6 @@ public interface AttributeListener {

void removeUserIdentity(MParticle.IdentityType identityType);

/**
* The mParticle SDK exposes a logout API, allowing developers to track an event
* when a user logs out of their app/platform. Use this opportunity to perform the appropriate logic
* as per your platforms logout paradigm, such as clearing user attributes.
*
* @return Kits should return a List of ReportingMessages indicating that the logout was processed one or more times, or null if it was not processed
*/
List<ReportingMessage> logout();

}

/**
Expand Down
5 changes: 2 additions & 3 deletions android-kit-base/src/main/java/com/mparticle/kits/KitManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,9 +809,8 @@ public void removeUserIdentity(MParticle.IdentityType identityType) {
public void logout() {
for (KitIntegration provider : providers.values()) {
try {
if (provider instanceof KitIntegration.AttributeListener && !provider.isDisabled()) {
List<ReportingMessage> report = ((KitIntegration.AttributeListener) provider).logout();
getReportingManager().logAll(report);
if (provider instanceof KitIntegration.LogoutListener listener && !provider.isDisabled()) {
getReportingManager().logAll(listener.logout());
}
} catch (Exception e) {
Logger.warning("Failed to call logout for kit: " + provider.getName() + ": " + e.getMessage());
Expand Down
2 changes: 2 additions & 0 deletions kits/adobe/adobe-5/src/main/kotlin/com/mparticle/kits/AdobeKitBase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.mparticle.internal.MPUtility
import com.mparticle.internal.MPUtility.AdIdInfo
import com.mparticle.kits.KitIntegration.ApplicationStateListener
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.LogoutListener
import com.mparticle.kits.KitIntegration.PushListener
import org.json.JSONException
import org.json.JSONObject
Expand All @@ -16,6 +17,7 @@ import java.net.URL
abstract class AdobeKitBase :
KitIntegration(),
AttributeListener,
LogoutListener,
PushListener,
ApplicationStateListener {
private val dVer = "2"
Expand Down
2 changes: 2 additions & 0 deletions kits/adobemedia/adobemedia-5/src/main/kotlin/com/mparticle/kits/AdobeKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import com.mparticle.MParticle
import com.mparticle.kits.KitIntegration.ApplicationStateListener
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.EventListener
import com.mparticle.kits.KitIntegration.LogoutListener
import com.mparticle.kits.KitIntegration.PushListener
import com.mparticle.media.events.ContentType
import com.mparticle.media.events.EventAttributes
Expand All @@ -36,6 +37,7 @@ open class AdobeKit :
KitIntegration(),
EventListener,
AttributeListener,
LogoutListener,
PushListener,
ApplicationStateListener {
companion object {
Expand Down
1 change: 1 addition & 0 deletions kits/appsflyer/appsflyer-6/src/main/kotlin/com/mparticle/kits/AppsFlyerKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ class AppsFlyerKit :
KitIntegration(),
KitIntegration.EventListener,
KitIntegration.AttributeListener,
KitIntegration.LogoutListener,
KitIntegration.CommerceListener,
AppsFlyerConversionListener,
KitIntegration.ActivityListener,
Expand Down
2 changes: 2 additions & 0 deletions kits/apptimize/apptimize-3/src/main/kotlin/com/mparticle/kits/ApptimizeKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ import com.mparticle.MParticle.IdentityType
import com.mparticle.commerce.CommerceEvent
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.CommerceListener
import com.mparticle.kits.KitIntegration.LogoutListener
import java.math.BigDecimal

class ApptimizeKit :
KitIntegration(),
AttributeListener,
LogoutListener,
KitIntegration.EventListener,
CommerceListener,
OnTestRunListener {
Expand Down
2 changes: 2 additions & 0 deletions kits/branch/branch-5/src/main/kotlin/com/mparticle/kits/BranchMetricsKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.CommerceListener
import com.mparticle.kits.KitIntegration.EventListener
import com.mparticle.kits.KitIntegration.IdentityListener
import com.mparticle.kits.KitIntegration.LogoutListener
import io.branch.referral.Branch
import io.branch.referral.Branch.BranchReferralInitListener
import io.branch.referral.BranchError
Expand All @@ -37,6 +38,7 @@ class BranchMetricsKit :
EventListener,
CommerceListener,
AttributeListener,
LogoutListener,
ApplicationStateListener,
IdentityListener,
BranchReferralInitListener {
Expand Down
1 change: 1 addition & 0 deletions kits/braze/braze-38/src/main/kotlin/com/mparticle/kits/AppboyKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import kotlin.collections.HashMap
open class AppboyKit :
KitIntegration(),
AttributeListener,
KitIntegration.LogoutListener,
CommerceListener,
KitIntegration.EventListener,
PushListener,
Expand Down
1 change: 1 addition & 0 deletions kits/braze/braze-39/src/main/kotlin/com/mparticle/kits/AppboyKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import kotlin.collections.HashMap
open class AppboyKit :
KitIntegration(),
AttributeListener,
KitIntegration.LogoutListener,
CommerceListener,
KitIntegration.EventListener,
PushListener,
Expand Down
1 change: 1 addition & 0 deletions kits/braze/braze-40/src/main/kotlin/com/mparticle/kits/AppboyKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import kotlin.collections.HashMap
open class AppboyKit :
KitIntegration(),
AttributeListener,
KitIntegration.LogoutListener,
CommerceListener,
KitIntegration.EventListener,
PushListener,
Expand Down
1 change: 1 addition & 0 deletions kits/braze/braze-41/src/main/kotlin/com/mparticle/kits/AppboyKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import kotlin.collections.HashMap
open class AppboyKit :
KitIntegration(),
AttributeListener,
KitIntegration.LogoutListener,
CommerceListener,
KitIntegration.EventListener,
PushListener,
Expand Down
2 changes: 2 additions & 0 deletions kits/comscore/comscore-6/src/main/kotlin/com/mparticle/kits/ComscoreKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ import com.mparticle.MParticle
import com.mparticle.MParticle.IdentityType
import com.mparticle.kits.KitIntegration.ActivityListener
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.LogoutListener
import java.util.HashMap
import java.util.LinkedList

class ComscoreKit :
KitIntegration(),
KitIntegration.EventListener,
AttributeListener,
LogoutListener,
ActivityListener {
private var isEnterprise = false

Expand Down
2 changes: 2 additions & 0 deletions kits/kochava/kochava-5/src/main/kotlin/com/mparticle/kits/KochavaKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ import com.mparticle.AttributionResult
import com.mparticle.MParticle.IdentityType
import com.mparticle.identity.MParticleUser
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.LogoutListener
import org.json.JSONException
import org.json.JSONObject

class KochavaKit :
KitIntegration(),
AttributeListener,
LogoutListener,
KitIntegration.IdentityListener {
override fun getName(): String = NAME

Expand Down
2 changes: 2 additions & 0 deletions kits/localytics/localytics-6/src/main/kotlin/com/mparticle/kits/LocalyticsKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.mparticle.internal.MPUtility
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.CommerceListener
import com.mparticle.kits.KitIntegration.EventListener
import com.mparticle.kits.KitIntegration.LogoutListener
import com.mparticle.kits.KitIntegration.PushListener
import com.mparticle.kits.ReportingMessage
import org.json.JSONArray
Expand All @@ -31,6 +32,7 @@ class LocalyticsKit :
KitIntegration.EventListener,
CommerceListener,
AttributeListener,
LogoutListener,
PushListener,
CallToActionListener {
private var customDimensionJson: JSONArray? = null
Expand Down
4 changes: 3 additions & 1 deletion kits/singular/singular-12/src/main/kotlin/com/mparticle/kits/SingularKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.mparticle.kits.KitIntegration.ApplicationStateListener
import com.mparticle.kits.KitIntegration.AttributeListener
import com.mparticle.kits.KitIntegration.CommerceListener
import com.mparticle.kits.KitIntegration.EventListener
import com.mparticle.kits.KitIntegration.LogoutListener
import com.mparticle.kits.KitIntegration.PushListener
import com.mparticle.kits.KitIntegration.UserAttributeListener
import com.singular.sdk.SDIDAccessorHandler
Expand All @@ -38,7 +39,8 @@ open class SingularKit :
CommerceListener,
ApplicationStateListener,
UserAttributeListener,
AttributeListener {
AttributeListener,
LogoutListener {
interface DeviceAttributionCallback : SingularDeviceAttributionHandler

interface SdidAccessorHandler : SDIDAccessorHandler
Expand Down
3 changes: 2 additions & 1 deletion kits/urbanairship/urbanairship-20/src/main/kotlin/com/mparticle/kits/UrbanAirshipKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ class UrbanAirshipKit :
KitIntegration.PushListener,
KitIntegration.EventListener,
CommerceListener,
KitIntegration.AttributeListener {
KitIntegration.AttributeListener,
KitIntegration.LogoutListener {
private var channelIdListener: ChannelIdListener? = null
private var configuration: UrbanAirshipConfiguration? = null

Expand Down
Loading