Enum - MessagingEdgeEventType

Provides mapping to XDM EventType strings needed for Experience Event requests.

This enum is used in conjunction with the track(_:withEdgeEventType:) method of a Message object.

Definition

data-variant=warning

data-slots=text1, text2

Android Java

public enum MessagingEdgeEventType {
    PUSH_APPLICATION_OPENED(4),
    PUSH_CUSTOM_ACTION(5),
    DISMISS(6),
    INTERACT(7),
    TRIGGER(8),
    DISPLAY(9),
    DISQUALIFY(10),
    SUPPRESS_DISPLAY(11);

    MessagingEdgeEventType(final int value) {
        this.value = value;
    }

    /**
     * @deprecated This method will be removed in future versions.
     */
    @Deprecated
    public int getValue() {
        return value;
    }

    public String getPropositionEventType() {
        switch (this) {
            case DISMISS:
                return PROPOSITION_EVENT_TYPE_DISMISS;
            case INTERACT:
                return PROPOSITION_EVENT_TYPE_INTERACT;
            case TRIGGER:
                return PROPOSITION_EVENT_TYPE_TRIGGER;
            case DISPLAY:
                return PROPOSITION_EVENT_TYPE_DISPLAY;
            case DISQUALIFY:
                return PROPOSITION_EVENT_TYPE_DISQUALIFY;
            case SUPPRESS_DISPLAY:
                return PROPOSITION_EVENT_TYPE_SUPPRESS_DISPLAY;
            default:
                return "";
        }
    }

    @NonNull @Override
    public String toString() {
        switch (this) {
            case DISMISS:
                return PROPOSITION_EVENT_TYPE_DISMISS_STRING;
            case INTERACT:
                return PROPOSITION_EVENT_TYPE_INTERACT_STRING;
            case TRIGGER:
                return PROPOSITION_EVENT_TYPE_TRIGGER_STRING;
            case DISPLAY:
                return PROPOSITION_EVENT_TYPE_DISPLAY_STRING;
            case DISQUALIFY:
                return PROPOSITION_EVENT_TYPE_DISQUALIFY_STRING;
            case SUPPRESS_DISPLAY:
                return PROPOSITION_EVENT_TYPE_SUPPRESS_DISPLAY_STRING;
            case PUSH_APPLICATION_OPENED:
                return PUSH_NOTIFICATION_EVENT_TYPE_STRING_OPENED;
            case PUSH_CUSTOM_ACTION:
                return PUSH_NOTIFICATION_EVENT_TYPE_STRING_CUSTOM_ACTION;
            default:
                return super.toString();
        }
    }
}

data-variant=warning

data-slots=text1, text2

iOS Swift

@objc(AEPMessagingEdgeEventType)
public enum MessagingEdgeEventType: Int {
    case pushApplicationOpened = 4
    case pushCustomAction = 5
    case dismiss = 6
    case interact = 7
    case trigger = 8
    case display = 9
    case disqualify = 10
    case suppressDisplay = 11

    public func toString() -> String {
        switch self {
        case .dismiss:
            return MessagingConstants.XDM.Inbound.EventType.DISMISS
        case .trigger:
            return MessagingConstants.XDM.Inbound.EventType.TRIGGER
        case .interact:
            return MessagingConstants.XDM.Inbound.EventType.INTERACT
        case .display:
            return MessagingConstants.XDM.Inbound.EventType.DISPLAY
        case .disqualify:
            return MessagingConstants.XDM.Inbound.EventType.DISQUALIFY
        case .suppressDisplay:
            return MessagingConstants.XDM.Inbound.EventType.SUPPRESSED_DISPLAY
        case .pushCustomAction:
            return MessagingConstants.XDM.Push.EventType.CUSTOM_ACTION
        case .pushApplicationOpened:
            return MessagingConstants.XDM.Push.EventType.APPLICATION_OPENED
        }
    }
}

String values

Below is the table of values returned by calling the toString method for each case, which are used as the XDM eventType in outgoing experience events:

Android

iOS