Skip to content

Commit 789ae83

Browse files
committed
refactor: remove unused methods and improve documentation in IterableEmbeddedManager
1 parent 2a62913 commit 789ae83

1 file changed

Lines changed: 8 additions & 60 deletions

File tree

Lines changed: 8 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,14 @@
1-
import { IterableLogger } from '../../core/classes/IterableLogger';
2-
31
/**
4-
* Manages the embedded messages from Iterable.
2+
* Manages embedded messages from Iterable.
3+
*
4+
* **Documentation**
5+
* - [Embedded Messaging Overview](https://support.iterable.com/hc/en-us/articles/23060529977364-Embedded-Messaging-Overview)
6+
* - [Android Embedded Messaging](https://support.iterable.com/hc/en-us/articles/23061877893652-Embedded-Messages-with-Iterable-s-Android-SDK)
7+
* - [iOS Embedded Messaging](https://support.iterable.com/hc/en-us/articles/23061840746900-Embedded-Messages-with-Iterable-s-iOS-SDK)
58
*/
69
export class IterableEmbeddedManager {
710
/**
8-
* Refreshes the local cache of your embedded manager system so that it aligns
9-
* with the server.
10-
*
11-
* At key points during your app's lifecycle, you may want to manually refresh
12-
* your app's local cache of embedded messages. For example, as users navigate
13-
* around, on pull-to-refresh, etc.
14-
*
15-
* @returns A promise that returns messages that the user is *eligible* to see.
16-
*
17-
* @example
18-
* ```typescript
19-
* IterableEmbeddedManager.syncMessages().then(messages => {
20-
* console.log('Messages:', messages);
21-
* });
22-
* ```
11+
* Whether the embedded manager is enabled.
2312
*/
24-
syncMessages() {
25-
IterableLogger.log('IterableEmbeddedManager.syncMessages');
26-
}
27-
28-
getMessages(placementIds?: number[] | null) {
29-
IterableLogger.log(
30-
'IterableEmbeddedManager.getMessages with placementIds',
31-
placementIds
32-
);
33-
}
34-
35-
getPlacementIds() {
36-
IterableLogger.log('IterableEmbeddedManager.getEmbeddedPlacementIds');
37-
}
38-
39-
startSession() {
40-
IterableLogger.log('IterableEmbeddedManager.startSession');
41-
}
42-
43-
endSession() {
44-
IterableLogger.log('IterableEmbeddedManager.endSession');
45-
}
46-
47-
startImpression(messageId: string, placementId: number) {
48-
IterableLogger.log(
49-
'IterableEmbeddedManager.startImpression',
50-
messageId,
51-
placementId
52-
);
53-
}
54-
55-
pauseImpression(messageId: string) {
56-
IterableLogger.log('IterableEmbeddedManager.pauseImpression', messageId);
57-
}
58-
59-
handleClick() {
60-
IterableLogger.log('IterableEmbeddedManager.handleClick');
61-
}
62-
63-
trackClick() {
64-
IterableLogger.log('IterableEmbeddedManager.trackClick');
65-
}
13+
isEnabled = false;
6614
}

0 commit comments

Comments
 (0)