MCLShareState

enum MCLShareState {}

Different states a share can be in. All shares start as sent, becomes clicked when it has had at least one link click, and then becomes either opened or installed.

Note that the state only moves in one direction, towards the best outcome that has come from it. Thus a share that receives several link clicks where some lead to re-engagements (opened) and some to an install, once the first install happens the state will never change from installed.

To keep more granualar track of how many installs or re-engagements a share has generated you need to listen to the {@link SentShareOpenedEvent} and keep count yourself.

  • The share has been sent. This is the default state of a share until something happens with the link.

    Declaration

    Objective-C

    MCLShareStateSent = MCL_SHARE_STATE_SENT

    Swift

    case sent = 0

  • The share link has been clicked. If this state remains, assume that the receiver didn’t complete an install or didn’t have the app installed already.

    Note that depending on where the share was sent this might not mean the recipient clicked on it consciously, it might have been clicked automatically by the app to generate a link preview or similar. It’s likely the preview was seen by the recipient, but the recipient hasn’t necessarily expressed intent to click the share.

    Declaration

    Objective-C

    MCLShareStateClicked = MCL_SHARE_STATE_CLICKED

    Swift

    case clicked = 1

  • The share led to at least one existing user opening the app (re-engagement).

    The share can have led to several re-engagements, but no new installs.

    Declaration

    Objective-C

    MCLShareStateOpened = MCL_SHARE_STATE_OPENED

    Swift

    case opened = 2

  • The share led to at least one new user installing the app.

    The share can have generated multiple installs and re-engagements in this state.

    Declaration

    Objective-C

    MCLShareStateInstalled = MCL_SHARE_STATE_INSTALLED

    Swift

    case installed = 3