Messages Guide

This messages guide assumes that you have already completed the TheM>Getting Started>Quick Start guide and are familiar with TheM class, TheM submodule initialization, and creating/listening for custom events. This guide also assumes that you have already installed the amplifi_mobile_sdk package into your project and placed the following minified libraries in the /lib folder of your project: axios.min.js (Optional - fetch will be used if axios is not present), crypto-js.min.js, lz-string.min.js, moment.min.js, and socket.io.min.js. In addition, you should have completed the Onboarding Guide tutorial in order to create and onboard a user which can be logged into your ampliFi instance.

1. In the src folder of your project (from the Quick Start guide of the TheM Getting Started section), create a new file called message.js with the following code.

message.js

import ClassTheM from "../node_modules/@PayGearsCorp/amplifi_mobile_sdk/TheM/them.mjs";

import { thisDevice } from "./android-demo-device.js"; //android device emulator for testing

const AMPLIFI_BASE_URL = "PUT_YOUR_INSTANCE_URL_HERE"; //Speak to a support representative to be issued a sandbox instance URL
const AMPLIFI_CORE_URL = `${AMPLIFI_BASE_URL}core/`;
const DEVICE_TAG = "PUT_YOUR_DEVICE_TAG_HERE"; //Use deviceTag obtained from onboarding tutorial for this device

const subClassesToInit = [
    //"accounts",
    //"attachments",
    //"beneficiaries",
    //"cards",
    //"cheques",
    "common",
    //"companies",
    //"externalAccounts",
    //"fdrs",
    //"fundstransfer",
    //"fxrates",
    //"genericRequests",
    //"ious",
    "messages",
    //"onboarding",
    //"payees",
    //"remittance",
    //"restrictions",
    //"statics",
    "user"
];


export const messagesTutorial = async (subClasses = "") => {
    TheM = new ClassTheM({
        config: {
            AFiInstanceId: "test",
            modulesFolder: "",
            modulesFolderOnboarding: "",
            webworkerFolder: "../TheM/",
            baseLibURL: "../demo/lib/",
            backEndURL: AMPLIFI_CORE_URL,
            socketURL: AMPLIFI_BASE_URL,
        },
        libs: {
        }
    });

    //Emulate user device before initializing TheM submodules
    TheM.thisDevice = {
        ...thisDevice,
        TheM,
        deviceTag: DEVICE_TAG,
    };

    //Initialize desired submodules
    //Some modules depend on others so must be initialized together
    //For instance, most submodules require the "common" subclass to be initialized
    await TheM.doInit(subClasses);

    //messages workflow to try
    //Uncomment to run the whole workflow or follow the instructions in the browser
    /*
    //Prepare for logging in
    //Log in using the instructions in the browser or use the doAuthenticate method from the device emulator we created during onboarding
    await TheM.thisDevice.doAuthenticate(DEVICE_TAG);

    //Pull fresh messages data from the server if necessary
    await TheM.messages.doUpdate();

    //Create a new message object
    let newMessage = TheM.messages.newMessage;

    //Populate the message properties
    newMessage.text = "This is a message text"; //required

    //Can also set optional message properties dedupCode, dtsCreated, toAFiUserId, or let these properties be automatically generated upon submission
    //newMessage.dedupCode = "RandomStringToAvoidDuplication123"; //optional
    newMessage.dtsCreated = new Date(); //optional
    newMessage.toAFiUserId = TheM.user.AFiUserId; //optional

    //Submit the message to the server
    let result = await TheM.messages.doSubmit(newMessage); //or await TheM.messages.doSubmit("A string to be used as the message text");

    //Examples of listing messages
    console.log(`TheM.messages.all: ${JSON.stringify(TheM.messages.all)}`);
    console.log(`TheM.messages.unread: ${JSON.stringify(TheM.messages.unread)}`);
    console.log(`TheM.messages.unreadIsImportant: ${JSON.stringify(TheM.messages.unreadIsImportant)}`);

    //Mark the message as read
    if (result.success && result.message) {
        console.log(`The message was submitted successfully: ${JSON.stringify(result)}`);
        console.log("Will mark the message as read.");
        await TheM.messages.doMarkRead(result.message.AFiMessageId);
    } else {
        console.log(`The message was not submitted successfully: ${JSON.stringify(result)}`);
    }

    //Logout when finished
    //await TheM.user.doLogout();
    */
};

await messagesTutorial(subClassesToInit.join(" "));

2. The message module expects the user to be using some type of device so make sure the android-demo-device.js file used during onboarding is still in your /src folder.

3. Create a new file in the /demo folder of your project called message.html with the following code.

message.html

<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />

    <title>ampliFi</title>

    <script>
        var TheM;
        var TheM_config;
    </script>

    <script src="../lib/socket.io.min.js"></script>
    <script src="../lib/lz-string.min.js"></script>
    <script src="../lib/moment.min.js"></script>
    <script src="../lib/axios.min.js"></script>
    <script src="../lib/crypto-js.min.js"></script>
    <script type="module" src="/../src/messages.js"></script>

    <style>
        html {
            color: white;
            background-color: black;
        }
    </style>
</head>


<body>
    <div>
        Hit F12 to open the browser console.
        Start working with TheM by typing "TheM" into the browser console.
    </div>
    <br />
    <br />
    <div>
        1. In order to log a user in, we will need to prepare the user credentials using the encryptedServerSecret
        stored locally during onboarding the company. Type the following to retrieve the encryptedServerSecret. (Or skip
        steps 1-5
        by using the doAuthenticate method in the device emulator like so, `await
        TheM.thisDevice.doAuthenticate(DEVICE_TAG);`.)
        <br /><br />
        <code>let { encryptedServerSecret } = await TheM.thisDevice.retrieveLocally("encryptedServerSecret", true);</code>
        <br /><br />
        Type <code>encryptedServerSecret</code> into the browser console and hit enter to view the encryptedServerSecret
        value.
        <br /><br />
        2. Since we are using an emulated android device to log in, we need to get the cryptotext value like so.
        <br /><br />
        <code>
            let _SUPER_SECRET = "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000";<br />
            let _dtsValueString = (new Date()).valueOf().toString();<br />
            let serverSecret = CryptoJS.AES.decrypt(encryptedServerSecret, _SUPER_SECRET).toString(CryptoJS.enc.Utf8);<br />
            let cryptotext = CryptoJS.AES.encrypt((TheM.thisDevice.deviceTag) + _dtsValueString, serverSecret).toString(); 
        </code>
        <br /><br />
        3. Set a socket connection for bidirectional communication.
        <br /><br />
        <pre><code>TheM.thisDevice.halfRef = TheM.common.GetRandomSTR(40);<br />let manager = new TheM.io.Manager(TheM.config.socketURL + "?halfRef=" + TheM.thisDevice.halfRef, {<br />  autoConnect: false<br />});<br />let socket = manager.socket("/");</code></pre>
        <br />
        4. Open the socket connection.
        <br /><br />
        <pre><code>manager.connect(function (data) {<br />  console.log("established real-time comm channel for onboarding");<br />  TheM.thisDevice.isRealTimeCommAvailable = true;<br />});</code></pre>
        <br />
        5. Log the user in using the deviceTag obtained during onboarding and the newly created cryptotext.
        <br /><br />
        <pre><code>const credentials = {<br />  "dtsValueString": _dtsValueString,<br />  "deviceTag": "PUT_DEVICE_TAG_HERE",<br />  "deviceData": TheM.thisDevice.data,<br />  "channel": TheM.thisDevice.platform,<br />  "dynamicScreensVersion": TheM.thisDevice.dynamicScreensVersion,<br />  "socket": {<br />    halfRef: TheM.thisDevice.halfRef<br />  },<br />  "pushMessToken": TheM.thisDevice.pushMessToken,<br />  "cryptotext": cryptotext<br />};<br />await TheM.user.doLogin(credentials);</code></pre>
        <br />
        6. After authentication, pull fresh data from the server if necessary.
        <br /><br />
        <code>await TheM.messages.doUpdate();</code>
        <br /><br />
        7. Create a new message object.
        <br /><br />
        <code>let newMessage = TheM.messages.newMessage;</code>
        <br /><br />
        8. Populate the message properties.
        <br /><br />
        <code>newMessage.text = "This is a message text"; //required</code>
        <br /><br />
        9. Populate optional properties if desired.
        <br /><br />
        <code>newMessage.dedupCode = "RandomStringToAvoidDuplication123"; //optional<br />newMessage.dtsCreated = new Date(); //optional<br />newMessage.toAFiUserId = TheM.user.AFiUserId; //optional</code>
        <br /><br />
        10. Submit the message to the server.
        <br /><br />
        <code>let result = await TheM.messages.doSubmit(newMessage); //or await TheM.messages.doSubmit("A string to be used as the message text");</code>
        <br /><br />
        11. Try listing messages if desired.
        <br /><br />
        <code>console.log(`TheM.messages.all: ${JSON.stringify(TheM.messages.all)}`);<br />console.log(`TheM.messages.unread: ${JSON.stringify(TheM.messages.unread)}`);<br />console.log(`TheM.messages.unreadIsImportant: ${JSON.stringify(TheM.messages.unreadIsImportant)}`);</code>
        <br /><br />
        12. Mark the message as read.
        <br /><br />
        <code>await TheM.messages.doMarkRead(result.message.AFiMessageId);</code>
        <br /><br />
        13. Keep exploring TheM.messages properties and methods and log out when finished.
        <br /><br />
        <code>
            await TheM.user.doLogout();
        </code>
        <br /><br />
    </div>
</body>

</html>

4. Start a server in the root folder of your project.

py -m http.server 8000

5. Open a browser and enter the following URL: http://localhost:8000/demo/

6. Click on the link for "message.html" and follow the instructions to log in, create a new message, assign the message properties, submit the message request to the server, mark a message as read, and log out.