Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,17 @@ public void onInboxUpdated() {

// ---------------------------------------------------------------------------------------
// region Embedded messaging

public void startEmbeddedSession() {
IterableLogger.d(TAG, "startEmbeddedSession");
IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().startSession();
}

public void endEmbeddedSession() {
IterableLogger.d(TAG, "endEmbeddedSession");
IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().endSession();
}

public void getEmbeddedPlacementIds(Promise promise) {
IterableLogger.d(TAG, "getEmbeddedPlacementIds");
try {
Expand Down
10 changes: 10 additions & 0 deletions android/src/newarch/java/com/RNIterableAPIModule.java
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,16 @@ public void pauseAuthRetries(boolean pauseRetry) {
moduleImpl.pauseAuthRetries(pauseRetry);
}

@Override
public void startEmbeddedSession() {
moduleImpl.startEmbeddedSession();
}

@Override
public void endEmbeddedSession() {
moduleImpl.endEmbeddedSession();
}

@Override
public void getEmbeddedPlacementIds(Promise promise) {
moduleImpl.getEmbeddedPlacementIds(promise);
Expand Down
10 changes: 10 additions & 0 deletions android/src/oldarch/java/com/RNIterableAPIModule.java
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,16 @@ public void pauseAuthRetries(boolean pauseRetry) {
moduleImpl.pauseAuthRetries(pauseRetry);
}

@ReactMethod
public void startEmbeddedSession() {
moduleImpl.startEmbeddedSession();
}

@ReactMethod
public void endEmbeddedSession() {
moduleImpl.endEmbeddedSession();
}

@ReactMethod
public void getEmbeddedPlacementIds(Promise promise) {
moduleImpl.getEmbeddedPlacementIds(promise);
Expand Down
20 changes: 20 additions & 0 deletions example/src/components/Embedded/Embedded.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ export const Embedded = () => {
});
}, []);

const startEmbeddedSession = useCallback(() => {
console.log(
'startEmbeddedSession --> check android/ios logs to check if it worked'
);
Iterable.embeddedManager.startSession();
}, []);

const endEmbeddedSession = useCallback(() => {
console.log(
'endEmbeddedSession --> check android/ios logs to check if it worked'
);
Iterable.embeddedManager.endSession();
}, []);

return (
<View style={styles.container}>
<Text style={styles.text}>EMBEDDED</Text>
Expand All @@ -29,6 +43,12 @@ export const Embedded = () => {
<TouchableOpacity style={styles.button} onPress={getPlacementIds}>
<Text style={styles.buttonText}>Get placement ids</Text>
</TouchableOpacity>
<TouchableOpacity style={styles.button} onPress={startEmbeddedSession}>
<Text style={styles.buttonText}>Start embedded session</Text>
</TouchableOpacity>
<TouchableOpacity style={styles.button} onPress={endEmbeddedSession}>
<Text style={styles.buttonText}>End embedded session</Text>
</TouchableOpacity>
</View>
);
};
Expand Down
2 changes: 2 additions & 0 deletions src/api/NativeRNIterableAPI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ export interface Spec extends TurboModule {
pauseAuthRetries(pauseRetry: boolean): void;

// Embedded Messaging
startEmbeddedSession(): void;
endEmbeddedSession(): void;
getEmbeddedPlacementIds(): Promise<number[]>;

// Wake app -- android only
Expand Down
16 changes: 16 additions & 0 deletions src/core/classes/IterableApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,22 @@ export class IterableApi {
// ======================= EMBEDDED ===================== //
// ====================================================== //

/**
* Starts an embedded session.
*/
static startEmbeddedSession() {
IterableLogger.log('startEmbeddedSession');
return RNIterableAPI.startEmbeddedSession();
}

/**
* Ends an embedded session.
*/
static endEmbeddedSession() {
IterableLogger.log('endEmbeddedSession');
return RNIterableAPI.endEmbeddedSession();
}

/**
* Get the embedded placement IDs.
*/
Expand Down
40 changes: 40 additions & 0 deletions src/embedded/classes/IterableEmbeddedManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import { IterableApi } from '../../core/classes/IterableApi';
export class IterableEmbeddedManager {
/**
* Whether the embedded manager is enabled.
*
* This is set through the `enableEmbeddedMessaging` flag in the
* `IterableConfig` class.
*/
isEnabled = false;

Expand All @@ -25,4 +28,41 @@ export class IterableEmbeddedManager {
getPlacementIds() {
return IterableApi.getEmbeddedPlacementIds();
}

/**
* Starts a session.
*
* As session is a period of time when a user is on a screen or page that can
* display embedded messages.
*
* When a user comes to a screen or page in your app where embedded messages
* are displayed (in one or more placements), a session should be started.
*
* @example
* ```typescript
* IterableEmbeddedManager.startSession();
* ```
*/
startSession() {
return IterableApi.startEmbeddedSession();
}

/**
* Ends a session.
*
* When a user leaves a screen in your app where embedded messages are
* displayed, the session should be ended. This causes the SDK to send
* session and impression data back to the server.
*
* A session is tracked when it is ended, so you should be able to find
* tracking data after this method is called.
*
* @example
* ```typescript
* IterableEmbeddedManager.endSession();
* ```
*/
endSession() {
return IterableApi.endEmbeddedSession();
}
}