{"_id":"@cordova-plugin-agconnect/appmessaging","_rev":"2-4c34a9cacd808b151a96641c0c12b170","name":"@cordova-plugin-agconnect/appmessaging","dist-tags":{"latest":"1.2.0"},"versions":{"1.2.0-beta.1":{"name":"@cordova-plugin-agconnect/appmessaging","title":"Cordova Plugin AGC AppMessaging","description":"Cordova Plugin AGC AppMessaging","version":"1.2.0-beta.1","types":"./types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/AppGalleryConnect/agc-cordova-plugin.git","directory":""},"homepage":"https://developer.huawei.com/consumer/en/agconnect/","license":"Apache-2.0","licenseFilename":"LICENCE","cordova":{"id":"appmessaging","platforms":["android","ios"]},"keywords":["cordova","ecosystem:cordova","cordova-android","cordova-ios","appmessaging","huawei-appmessaging","agc-appmessaging"],"scripts":{"build:core":"tsc","build":"npm run build:core","watch":"tsc --watch"},"devDependencies":{"@types/cordova":"0.0.34"},"dependencies":{"@angular/core":"^10.2.3","@ionic-native/core":"^5.29.0","rxjs":"^6.6.3","typescript":"^4.1.2"},"bugs":{"url":"https://github.com/AppGalleryConnect/agc-cordova-plugin/issues"},"_id":"@cordova-plugin-agconnect/appmessaging@1.2.0-beta.1","_nodeVersion":"13.5.0","_npmVersion":"6.14.9","dist":{"integrity":"sha512-DnQXm4dziTsH3HUIfhoJ5zHYcxxe6YGsxjF4DhmXDSW+YOUMmugr3XPldAu272FwNAJ+f4VYwxPnNGU7EPiBKA==","shasum":"a1c5ffe8bca94fdc85825408b5ce4e9184d06891","tarball":"https://registry.npmjs.org/@cordova-plugin-agconnect/appmessaging/-/appmessaging-1.2.0-beta.1.tgz","fileCount":58,"unpackedSize":318545,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgE8M0CRA9TVsSAnZWagAAXREP/3rmFroOv+xPgaa5OkG4\nBTRrn6ayRWES+MChYGL6IZlblYjhKHNQ7DMzSnxZY7DyATUJw7CaWaa5/h1M\n/Na0qkI7s4fcCmZ/OiNAw2kMfHcqMkG3nqCecQLCPzG37T/uJssJXl0j5aDd\ns/0HixyTT/73tj0Si5W9RazxLeZjgeufhVi969fZlSWKwziU9NldLf+V7hps\nZHXkzYjenCYI5oUkJP3qPfsGR1z/axpEdeZBtwBEbyP5sgk4O4u/9d9FQLDf\n5M93LJxn7HBZkAQW7NePfEPIKLGgjKNFAtpJJ57Ote8ydfsnp9iTjAIA5PPe\nLaWio9h7cigIvCQATaGrrsyVDzohUHZ+7V2r7lch4uzV4dtpEoKVDcCOxu1q\nGGYuJYLwMUAhUKuWUEWwOuvNZJ2XR39oNT5in+okgUbWXNcfRcgXETde3vS/\nSwmEwrsIhtdBNkXppPNM2WIRLR5HRRIOR7DOnq7Th/Gs3vhLBmwu4UhN6dEO\nssjxGAOOdOaIG87rthjEUdv3N2lH6yUkmPGF6C5AUFW4COT1/9GL4ACYAtIr\nuqTEcSo5atCDvimXqnm9iFKr3Nx0PVHJXujv/M2+neLq/45t6u0syYhnICIc\nNBgTgask2TrvEhg6jw/Mp/NKTWiabFod1zDBYYiSsdst0GcGkAKNdEZtprly\n3A1S\r\n=x8zm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDvcf5hUjpdak2tIPVby/o5sNG8OkVXyzIioVYadmyJIgIhANF/G+1kyWVi+L5KBcXd/9K2jzlP3U+llUZzoLt9z8EP"}]},"_npmUser":{"name":"hwopencapability","email":"opencapability@huawei.com"},"directories":{},"maintainers":[{"name":"hwopencapability","email":"opencapability@huawei.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/appmessaging_1.2.0-beta.1_1611907891358_0.5141058425319183"},"_hasShrinkwrap":false},"1.2.0":{"name":"@cordova-plugin-agconnect/appmessaging","title":"Cordova Plugin AGC AppMessaging","description":"Cordova Plugin AGC AppMessaging","version":"1.2.0","types":"./types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/AppGalleryConnect/agc-cordova-plugin.git","directory":""},"homepage":"https://developer.huawei.com/consumer/en/agconnect/","license":"Apache-2.0","licenseFilename":"LICENCE","cordova":{"id":"appmessaging","platforms":["android","ios"]},"keywords":["cordova","ecosystem:cordova","cordova-android","cordova-ios","appmessaging","huawei-appmessaging","agc-appmessaging"],"scripts":{"build:core":"tsc","build":"npm run build:core","watch":"tsc --watch"},"devDependencies":{"@types/cordova":"0.0.34"},"dependencies":{"@angular/core":"^10.2.3","@ionic-native/core":"^5.29.0","rxjs":"^6.6.3","typescript":"^4.1.2"},"bugs":{"url":"https://github.com/AppGalleryConnect/agc-cordova-plugin/issues"},"_id":"@cordova-plugin-agconnect/appmessaging@1.2.0","_nodeVersion":"13.5.0","_npmVersion":"6.14.9","dist":{"integrity":"sha512-8Xl2BpILLI6TA3p4oadh1CReh0NVqoTLY87jro9UDbiearc1/urNNjas9WpVwyYAtbSMzey9b7wd7FUJDDnGUQ==","shasum":"157c74d40e1119a3ed02a0b014ba692f93ef9190","tarball":"https://registry.npmjs.org/@cordova-plugin-agconnect/appmessaging/-/appmessaging-1.2.0.tgz","fileCount":62,"unpackedSize":311545,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgo10QCRA9TVsSAnZWagAAf50P/A+G9ksHOabCM1aG0DdV\nFnw8YfRhjdDfGkkPStGR3AyxhIyVdTpF+U40G3o+KwkbRv94us0AMfzteYzo\nojlS2FKtu8v/Lp/LElFabmBjAibs4mv9y/hcfg2Qf67Zpj9NgZs8DRqnsMW+\nxQ28JnjPviJMnwRU1K+QWq50DkZdvbHC4vqq5lFmbLpfZh5m3lVdVyw23Q/D\nKudxmoT1+BVc/b50j0vPIKrwFD3mGlUp1tPxEGqQwwXXRPd71mDIMp41gvTR\nmtozciDZyvfBwP6Q4XMC2N16WoLbgAJCg4A1GlhAoOh+rZW0rjRm2bbd+iZS\nf9nMd7V89RGKQ+XOSQ8TvT4/FIb+SnZoZpChnBvHLJdMdwgGngfSuknT69Oa\n6vTp4QEmi6xRFGxNXNE5XlqQY2IYyIxWa3kWimqeoKhuvAmpPRKSqNzsTgBi\nhGTvLOG0qBFBOf7jRMsISUAVGg9pSuKiJ2nDgMVu+Dgdk+tCK9eWxMN3TneL\nMwQRF2L4DHUkGmJyuLKeBywyoVXJJfYFg+lUs5BhoJBRFT4x+fR4tco6oeT7\nJ8x5xSuGoj3izEtX9xpWqPrxCOnvLSZOFrWQyzJ+Cv76lu5Uueqj7mm9YIZL\nPHwGeSSlXY7lyQO8bbBocuSMS8DLcoy9GM66iZ1JdIxms09VUpSY8tW0hs94\nM3uh\r\n=wu4u\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCB5MAJISBqoOqSEMc835cJcHnzkOYQ4hx3Q/KAYSRg8wIgCTKvIMAa5C9UEMIupMxZZBqOCe5b+rVeT0tbSDnfWf8="}]},"_npmUser":{"name":"hwopencapability","email":"opencapability@huawei.com"},"directories":{},"maintainers":[{"name":"hwopencapability","email":"opencapability@huawei.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/appmessaging_1.2.0_1621318928119_0.8205236509965397"},"_hasShrinkwrap":false}},"time":{"created":"2021-01-29T08:11:31.141Z","1.2.0-beta.1":"2021-01-29T08:11:31.554Z","modified":"2022-04-05T01:21:29.632Z","1.2.0":"2021-05-18T06:22:08.318Z"},"maintainers":[{"name":"hwopencapability","email":"opencapability@huawei.com"}],"description":"Cordova Plugin AGC AppMessaging","homepage":"https://developer.huawei.com/consumer/en/agconnect/","keywords":["cordova","ecosystem:cordova","cordova-android","cordova-ios","appmessaging","huawei-appmessaging","agc-appmessaging"],"repository":{"type":"git","url":"git+https://github.com/AppGalleryConnect/agc-cordova-plugin.git","directory":""},"bugs":{"url":"https://github.com/AppGalleryConnect/agc-cordova-plugin/issues"},"license":"Apache-2.0","readme":"# Cordova Plugin AGC App Messaging\r\n\r\n## Contents\r\n\r\n- [1. Introduction](#1-introduction)\r\n- [2. Installation Guide](#2-installation-guide)\r\n  - [2.1. Creating a Project in AppGallery Connect](#21-creating-a-project-in-appgallery-connect)\r\n  - [2.2. Obtaining agconnect-services.json and agconnect-services.plist](#22-obtaining-agconnect-servicesjson-and-agconnect-servicesplist)\r\n  - [2.3. Cordova](#23-cordova)\r\n    - [2.3.1. iOS App Development](#231-ios-app-development)\r\n    - [2.3.2. Android App Development](#232-android-app-development)\r\n  - [2.4. Ionic](#24-ionic)\r\n    - [2.4.1. iOS App Development](#241-ios-app-development)\r\n    - [2.4.2. Android App Development](#242-android-app-development)\r\n- [3. API Reference](#3-api-reference)\r\n    - [3.1. AGCAppMessaging](#31-agcappmessaging)\r\n    - [3.2. BannerMessage](#32-bannermessage)\r\n    - [3.3. Banner](#33-banner)\r\n    - [3.4. CardMessage](#34-cardmessage)\r\n    - [3.5. Card](#35-card)\r\n    - [3.6. Button](#36-button)\r\n    - [3.7. PictureMessage](#37-picturemessage)\r\n    - [3.8. Picture](#38-picture)\r\n    - [3.9. Constants](#39-constants)\r\n    - [3.10. Data Types](#310-data-types)\r\n- [4. Configuration and Description](#4-configuration-and-description)\r\n- [5. Sample Project](#5-sample-project)\r\n- [6. Licensing and Terms](#6-licensing-and-terms)\r\n\r\n---\r\n\r\n## 1. Introduction\r\n\r\nThis plugin enables communication between Huawei App Messaging SDK and Cordova platform. It exposes all functionality provided by Huawei App Messaging SDK.\r\n\r\n---\r\n\r\n## 2. Installation Guide\r\n\r\nBefore you get started, you must register as a HUAWEI Developer and complete identity verification on the [HUAWEI Developer](https://developer.huawei.com/consumer/en/) website. For details, please refer to [Register a HUAWEI ID](https://developer.huawei.com/consumer/en/doc/10104).\r\n\r\n### 2.1. Creating a Project in AppGallery Connect\r\n\r\nCreating an app in AppGallery Connect is required in order to communicate with the Huawei services. To create an app, perform the following steps:\r\n\r\n1. Sign in to [AppGallery Connect](https://developer.huawei.com/consumer/en/service/josp/agc/index.html) and select **My projects**.\r\n2. Select your project from the project list or create a new one by clicking the **Add Project** button.\r\n3. Go to **Project settings** > **General information**, and click **Add App**.\r\n   If an app exists in the project, and you need to add a new one, expand the app selection area on the top of the page and click **Add App**.\r\n4. On the **Add App** page, enter the app information, and click **OK**.\r\n\r\n### 2.2. Obtaining agconnect-services.json and agconnect-services.plist\r\n\r\n1. Sign in to [AppGallery Connect](https://developer.huawei.com/consumer/en/service/josp/agc/index.html) and select your project from **My Projects**. Then go to **Project settings** > **General information**. In the **App information** field,\r\n\r\n   - If platform is Android, click **agconnect-services.json** button to download the configuration file.\r\n   - If platform is iOS, click **agconnect-services.plist** button to download the configuration file.\r\n\r\n### 2.3. Cordova\r\n\r\n1. Install Cordova CLI.\r\n\r\n   ```bash\r\n   npm install -g cordova\r\n   ```\r\n\r\n2. Create a new Cordova project or use existing Cordova project.\r\n\r\n   - To create new Cordova project, you can use **`cordova create path [id [name [config]]] [options]`** command. For more details please follow [CLI Reference - Apache Cordova](https://cordova.apache.org/docs/en/latest/reference/cordova-cli/index.html#cordova-create-command).\r\n\r\n3. Update the widget **`id`** property which is specified in the **`config.xml`** file. It must be same with **client > package_name** value of the **`agconnect-services.json`** and **`agconnect-services.plist`** files.\r\n\r\n4. Add the **Android** or **iOS** platform to the project if haven't done before.\r\n\r\n   ```bash\r\n   cordova platform add android\r\n   ```\r\n\r\n   ```bash\r\n   cordova platform add ios\r\n   ```\r\n\r\n5. Install `AGC App Messaging Cordova Plugin` to the project.\r\n\r\n- Run the following command in the root directory of your project to install it through **npm**.\r\n\r\n    ```bash\r\n    cordova plugin add @cordova-plugin-agconnect/appmessaging\r\n    ```\r\n\r\n#### 2.3.1. iOS App Development\r\n\r\n1. Add **`agconnect-services.plist`** file to the app's root directory of your Xcode project.\r\n\r\n2. Check Signing & Capabilities tab page of your Xcode project.\r\n\r\n3. Run the application.\r\n\r\n    ```bash\r\n    cordova run ios --device\r\n    ```\r\n\r\n#### 2.3.2. Android App Development\r\n\r\n1. Copy **`agconnect-services.json`** file to **`<project_root>/platforms/android/app`** directory your Android project.\r\n\r\n2. Run the application.\r\n\r\n   ```bash\r\n   cordova run android --device\r\n   ```\r\n\r\n### 2.4. Ionic\r\n\r\n1. Install Ionic CLI.\r\n\r\n   ```bash\r\n   npm install -g @ionic/cli\r\n   ```\r\n\r\n2. Create a new Ionic project or use existing Ionic project.\r\n\r\n   - To create a new Ionic project, you can use **`ionic start <name> <template> [options]`** command. For more details please follow [ionic start - Ionic Documentation](https://ionicframework.com/docs/cli/commands/start).\r\n\r\n3. Enable the **Cordova integration** if haven't done before.\r\n\r\n   ```bash\r\n   ionic integrations enable cordova\r\n   ```\r\n\r\n4. Update the widget **`id`** property which is specified in the **`config.xml`** file. It must be same with **client > package_name** value of the **`agconnect-services.json`** and **`agconnect-services.plist`** files.\r\n\r\n5. Set preference in your Ionic project config.xml.\r\n\r\n   ```xml\r\n   <!--platform iOS-->\r\n    <preference name=\"deployment-target\" value=\"11.0\" />\r\n    <preference name=\"SwiftVersion\" value=\"5\" />\r\n   ```\r\n\r\n6. Add the **Android** or **iOS** platform to the project if haven't done before.\r\n\r\n    ```bash\r\n    ionic cordova platform add android\r\n    ```\r\n    \r\n    ```bash\r\n    ionic cordova platform add ios\r\n    ```\r\n\r\n7. Install `AGC App Messaging Cordova Plugin` to the project.\r\n\r\n   a. Run the following command in the root directory of your project to install it through **npm**.\r\n\r\n   ```bash\r\n   ionic cordova plugin add @cordova-plugin-agconnect/appmessaging\r\n   ```\r\n\r\n8. Copy **agc-appmessaging** folder from **`node_modules/@cordova-plugin-agconnect/appmessaging/ionic/dist`** directory to **`node_modules/@ionic-native`** directory.\r\n\r\n##### 2.4.1 iOS App Development\r\n\r\n1. Add **`agconnect-services.plist`** file to the app's root directory of your Xcode project.\r\n\r\n2. Check Signing & Capabilities tab page of your Xcode project.\r\n\r\n3. Run the application.\r\n\r\n    ```bash\r\n    ionic cordova run ios --device\r\n    ```\r\n\r\n##### 2.4.2. Android App Development\r\n\r\n1. Copy **`agconnect-services.json`** file to **`<project_root>/platforms/android/app`** directory your Android project.\r\n\r\n2. Run the application.\r\n\r\n   ```bash\r\n   ionic cordova run android --device\r\n   ```\r\n   \r\nNOTICE:\r\n\r\nApp Messaging Cordova Plugin currently doesn't support changing orientation. Only a single landscape or portrait layout can be used.\r\n\r\n---\r\n\r\n## 3. API Reference\r\n\r\n### 3.1. AGCAppMessaging\r\n\r\nRepresents the message processing class.\r\n\r\n#### Public Method Summary\r\n\r\n| Method                                                 | Return Type        | Description                                                                                                                                                                                                                    |\r\n| ------------------------------------------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| setFetchMessageEnable(enabled:boolean)                 | `Promise<void>`    | Sets whether to allow the App Messaging SDK to synchronize in-app message data from the AppGallery Connect server.                                                                                                             |\r\n| setDisplayEnable(enabled:boolean)                      | `Promise<void>`    | Sets whether to allow the App Messaging SDK to display in-app messages.                                                                                                                                                        |\r\n| isDisplayEnable()                                      | `Promise<boolean>` | Checks whether the App Messaging SDK is allowed to display in-app messages.                                                                                                                                                    |\r\n| isFetchMessageEnable()                                 | `Promise<boolean>` | Checks whether the App Messaging SDK is allowed to synchronize in-app message data from the AppGallery Connect server.                                                                                                         |\r\n| addListener(event: Events, callback: (appMessage: CardMessage or PictureMessage or BannerMessage, dismissType?: DismissType) => void) | `Promise<void>`    | Adds a listener for given event value.                                                                                                          |\r\n| setForceFetch()                                        | `Promise<string>`    | Sets the forcible in-app message data obtaining flag. When the flag is enabled, you can obtain latest in-app message data from the AppGallery Connect server in real time. This method is only to support on Android Platform. |\r\n| setDisplayLocation(location:Location)                  | `Promise<void>`    | Sets the display position of a pop-up or image message.                                                                                                                                                                        |\r\n| trigger(eventId:string)                                | `Promise<void>`    | Triggers a custom event.                                                                                                                                                                                                       |\r\n\r\n#### Public Methods\r\n\r\n##### setFetchMessageEnable(enabled:boolean)\r\n\r\nSets whether to allow the App Messaging SDK to synchronize in-app message data from the AppGallery Connect Server.\r\n\r\n###### Parameters\r\n\r\n| Name    | Type    | Description                                                                                                                                                                                                  |\r\n| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| enabled | boolean | Indicates whether to allow the App Messaging SDK to synchronize in-app message data from the AppGallery Connect server. The options are as follows:<br>true: yes<br>false: no.<br>The default value is true. |\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<void>` | Empty Promise. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function setFetchMessageEnable() {\r\n  const enabled: boolean = true;\r\n  await AGCAppMessaging.setFetchMessageEnable(enabled);\r\n}\r\n```\r\n\r\n##### setDisplayEnable(enabled:boolean)\r\n\r\nSets whether to allow the App Messaging SDK to display in-app messages.\r\n\r\n###### Parameters\r\n\r\n| Name    | Type    | Description                                                                                                                                                     |\r\n| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| enabled | boolean | Indicates whether to allow the App Messaging SDK to display in-app messages.The options are as follows:<br>true: yes<br>false: no<br>The default value is true. |\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<void>` | Empty Promise. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function setDisplayEnable() {\r\n  const enabled: boolean = true;\r\n  await AGCAppMessaging.setDisplayEnable(enabled);\r\n}\r\n```\r\n\r\n##### isDisplayEnable()\r\n\r\nChecks whether to allow the App Messaging SDK to display in-app messages.\r\n\r\n###### Return Type\r\n\r\n| Type               | Description                                                                                                                        |\r\n| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |\r\n| `Promise<boolean>` | Indicates whether to allow the App Messaging SDK to display in-app messages. The options are as follows:<br>true: yes<br>false: no |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function isDisplayEnable() {\r\n  await AGCAppMessaging.isDisplayEnable();\r\n}\r\n```\r\n\r\n##### isFetchMessageEnable()\r\n\r\nChecks whether to allow the App Messaging SDK to synchronize in-app message data from the AppGallery Connect Server.\r\n\r\n###### Return Type\r\n\r\n| Type               | Description                                                                                                                                                                   |\r\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `Promise<boolean>` | Indicates whether to allow the App Messaging SDK to synchronize in-app message data from the AppGallery Connect server. The options are as follows:<br>true: yes<br>false: no |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function isFetchMessageEnable() {\r\n  await AGCAppMessaging.isFetchMessageEnable();\r\n}\r\n```\r\n\r\n##### addListener(event: Events, callback: (appMessage: CardMessage | PictureMessage | BannerMessage, dismissType?: DismissType) => void)\r\n\r\nAdds a listener for given event value.\r\n\r\n###### Parameters\r\n\r\n| Name     | Type       | Description                                                 |\r\n| -------- | ---------- | ----------------------------------------------------------- |\r\n| event    | Events     | Indicated which event listener will be added for.           |\r\n| callback | function   | Callback function called when the given event is triggered. |\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<void>` | Empty Promise. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function addListener() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const id: string = appMessage.getId();\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### setForceFetch()\r\n\r\nSets the flag for whether to obtain in-app message data from the AppGallery Connect Server in real time by force.\r\n\r\nAfter this method is called, the App Messaging SDK does not immediately request data from the AppGallery Connect Server. When the next trigger event takes place, the App Messaging SDK forcibly obtains in-app message data from the AppGallery Connect Server.\r\n**For iOS platform:** Enable the debugging mode for your app. Add the '-AGConnectDeveloperMode' launch parameter to the app scheme. Start your app in Xcode debug-mode.\r\nNotice:\r\n\r\n- The setForceFetch API can be used only for message testing.\r\n- The forcible data obtaining flag is bound to the AAID of the test device. After you uninstall and reinstall the app or clear app data on the device, the flag will be reset.\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<string>` | Returns string 'Enabled' if operation is successful. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function setForceFetch() {\r\n    const result: string = await AGCAppMessaging.setForceFetch();\r\n    console.log(result);\r\n}\r\n```\r\n\r\n##### setDisplayLocation(location:Location)\r\n\r\nSets the display position of a pop-up or image message.\r\n\r\n###### Parameters\r\n\r\n| Name     | Type     | Description        |\r\n| -------- | -------- | ------------------ |\r\n| location | Location | Location instance. |\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<void>` | Empty Promise. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function setDisplayLocation() {\r\n  const location: Location = Location.BOTTOM;\r\n  await AGCAppMessaging.setDisplayLocation(location);\r\n}\r\n```\r\n\r\n##### trigger(eventId:string)\r\n\r\nTriggers a custom event.\r\n\r\n###### Parameters\r\n\r\n| Name    | Type   | Description           |\r\n| ------- | ------ | --------------------- |\r\n| eventId | string | ID of a custom event. |\r\n\r\n###### Return Type\r\n\r\n| Type            | Description    |\r\n| --------------- | -------------- |\r\n| `Promise<void>` | Empty Promise. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function trigger() {\r\n  const eventId = \"OnAppForeGround\";\r\n  await AGCAppMessaging.trigger(eventId);\r\n}\r\n```\r\n\r\n### 3.2. BannerMessage\r\n\r\nRepresents the banner message object class.\r\n\r\n#### Public Method Summary\r\n\r\n| Method              | Return Type   | Description                                         |\r\n| ------------------- | ------------- | --------------------------------------------------- |\r\n| getId()             | `string`      | Obtains the ID of an in-app message.                |\r\n| getMessageType()    | `MessageType` | Obtains the message type.                           |\r\n| getStartTime()      | `number`      | Obtains the start timestamp of a message.           |\r\n| getEndTime()        | `number`      | Obtains the end timestamp of a message.             |\r\n| getFrequencyType()  | `number`      | Obtains the display frequency type of a message.    |\r\n| getFrequencyValue() | `number`      | Obtains the display frequency of a message.         |\r\n| getTestFlag()       | `TestFlag`    | Checks whether an in-app message is a test message. |\r\n| getTriggerEvents()  | `string[]`    | Obtain the ID of a trigger event.                   |\r\n| getBanner()         | `Banner`      | Obtains the banner information of a message.        |\r\n\r\n#### Public Methods\r\n\r\n##### getId()\r\n\r\nObtains the ID of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description |\r\n| -------- | ----------- |\r\n| `string` | Message ID. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const id: string = appMessage.getId();\r\n      console.log(id);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getMessageType()\r\n\r\nObtains the message type.\r\n\r\n###### Return Type\r\n\r\n| Type          | Description                                                  |\r\n| ------------- | ------------------------------------------------------------ |\r\n| `MessageType` | Message type. The banner message type is MessageType.BANNER. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const messageType: MessageType = appMessage.getMessageType();\r\n      console.log(messageType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getStartTime()\r\n\r\nObtains the start timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                             |\r\n| -------- | ------------------------------------------------------- |\r\n| `number` | Start timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const startTime: number = appMessage.getStartTime();\r\n      console.log(startTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getEndTime()\r\n\r\nObtains the end timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                           |\r\n| -------- | ----------------------------------------------------- |\r\n| `number` | End timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const endTime: number = appMessage.getEndTime();\r\n      console.log(endTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyType()\r\n\r\nObtains the display frequency of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                                                                                                                                                           |\r\n| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `number` | Display frequency type of a message. The options are as follows: <br/>1: only once.<br/>2: once every X days. The value of X is the return value of getFrequencyValue.<br/>3: X days per day The value of X is the return value of getFrequencyValue. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyType: number = appMessage.getFrequencyType();\r\n      console.log(frequencyType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyValue()\r\n\r\nObtains the display frequency limit of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                        |\r\n| -------- | ------------------------------------------------------------------------------------------------------------------ |\r\n| `number` | Display frequency limit of an in-app message. This parameter is valid only when getFrequencyType is set to 2 or 3. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyValue: number = appMessage.getFrequencyValue();\r\n      console.log(frequencyValue);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTestFlag()\r\n\r\nChecks whether an in-app message is a test message.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                 |\r\n| ---------- | --------------------------------------------------------------------------------------------------------------------------- |\r\n| `TestFlag` | Checks whether an in-app message is a test message. The options are as follows:<br/>1: test message<br/>0: non-test message |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const testFlag: TestFlag = appMessage.getTestFlag();\r\n      console.log(testFlag);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTriggerEvents()\r\n\r\nA collection of in-app message trigger event types, which are selected by you in AppGallery Connect.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                                                                                                  |\r\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| `string[]` | A collection of in-app message trigger event types.The App Messaging SDK matches an event ID with the trigger event types of an in-app message. If the ID is in TriggerEvent, the message will be displayed. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const triggerEvents: string[] = appMessage.getTriggerEvents();\r\n      console.log(triggerEvents);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBanner()\r\n\r\nObtains the banner information of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                      |\r\n| -------- | -------------------------------- |\r\n| `Banner` | Banner information of a message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  const banner: Banner = appMessage.getBanner();\r\n  console.log(JSON.stringify(banner));\r\n}\r\n```\r\n\r\n### 3.3. Banner\r\n\r\nRepresents a banner message.\r\n\r\n#### Public Method Summary\r\n\r\n| Method                       | Return Type | Description                                                    |\r\n| ---------------------------- | ----------- | -------------------------------------------------------------- |\r\n| getTitle()                   | `string`    | Obtains the title of a banner message.                         |\r\n| getTitleColor()              | `string`    | Obtains the title color of a banner message.                   |\r\n| getTitleColorOpenness()      | `number`    | Obtains the title color transparency of a banner message.      |\r\n| getBody()                    | `string`    | Obtains the body of a banner message.                          |\r\n| getBodyColor()               | `string`    | Obtains the body color of a banner message.                    |\r\n| getBodyColorOpenness()       | `number`    | Obtains the body color transparency of a banner message.       |\r\n| getBackgroundColor()         | `string`    | Obtains the background color of a banner message.              |\r\n| getBackgroundColorOpenness() | `number`    | Obtains the background color transparency of a banner message. |\r\n| getPictureUrl()              | `string`    | Obtains the image URL of a banner message.                     |\r\n| getActionUrl()               | `string`    | Obtains the redirection URL in a banner message.               |\r\n\r\n#### Public Methods\r\n\r\n##### getTitle()\r\n\r\nObtains the title of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                |\r\n| -------- | -------------------------- |\r\n| `string` | Title of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const title: string = banner.getTitle();\r\n      console.log(title);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTitleColor()\r\n\r\nObtains the title color of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                      |\r\n| -------- | -------------------------------- |\r\n| `string` | Title color of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const titleColor: string = banner.getTitleColor();\r\n      console.log(titleColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTitleColorOpenness()\r\n\r\nObtains the title color transparency of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                   |\r\n| -------- | --------------------------------------------- |\r\n| `number` | Title color transparency of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const titleColorOpenness: number = banner.getTitleColorOpenness();\r\n      console.log(titleColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBody()\r\n\r\nObtains the body of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description               |\r\n| -------- | ------------------------- |\r\n| `string` | Body of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const body: string = banner.getBody();\r\n      console.log(body);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBodyColor()\r\n\r\nObtains the body color of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                     |\r\n| -------- | ------------------------------- |\r\n| `string` | Body color of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const bodyColor: string = banner.getBodyColor();\r\n      console.log(bodyColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBodyColorOpenness()\r\n\r\nObtains the body color transparency of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                  |\r\n| -------- | ---------------------------------------------------------------------------- |\r\n| `number` | Body color transparency of a banner message. The value ranges from 0 to 100. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const bodyColorOpenness: number = banner.getBodyColorOpenness();\r\n      console.log(bodyColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBackgroundColor()\r\n\r\nObtains the background color of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                  |\r\n| -------- | ------------------------------------------------------------ |\r\n| `string` | Background color of a banner message, which is an RGB value. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const backgroundColor: string = banner.getBackgroundColor();\r\n      console.log(backgroundColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBackgroundColorOpenness()\r\n\r\nObtains the background color transparency of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                        |\r\n| -------- | ---------------------------------------------------------------------------------- |\r\n| `number` | Background color transparency of a banner message. The value ranges from 0 to 100. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const backgroundColorOpenness: string = banner.getBackgroundColorOpenness();\r\n      console.log(backgroundColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getPictureUrl()\r\n\r\nObtains the image URL of a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                    |\r\n| -------- | ------------------------------ |\r\n| `string` | Image URL of a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const pictureUrl: string = banner.getPictureUrl();\r\n      console.log(pictureUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getActionUrl()\r\n\r\nObtains the redirection URL in a banner message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                          |\r\n| -------- | ------------------------------------ |\r\n| `string` | Redirection URL in a banner message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const banner: Banner = appMessage.getBanner();\r\n      const actionUrl: string = banner.getActionUrl();\r\n      console.log(actionUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n### 3.4. CardMessage\r\n\r\nRepresents a pop-up message.\r\n\r\n#### Public Method Summary\r\n\r\n| Method              | Return Type   | Description                                         |\r\n| ------------------- | ------------- | --------------------------------------------------- |\r\n| getId()             | `string`      | Obtains the ID of an in-app message.                |\r\n| getMessageType()    | `MessageType` | Obtains the message type.                           |\r\n| getStartTime()      | `number`      | Obtains the start timestamp of a message.           |\r\n| getEndTime()        | `number`      | Obtains the end timestamp of a message.             |\r\n| getFrequencyType()  | `number`      | Obtains the display frequency type of a message.    |\r\n| getFrequencyValue() | `number`      | Obtains the display frequency of a message.         |\r\n| getTestFlag()       | `TestFlag`    | Checks whether an in-app message is a test message. |\r\n| getTriggerEvents()  | `string[]`    | Obtain the ID of a trigger event.                   |\r\n| getCard()           | `Card`        | Obtains the card information of a pop-up message.   |\r\n\r\n#### Public Methods\r\n\r\n##### getId()\r\n\r\nObtains the ID of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description |\r\n| -------- | ----------- |\r\n| `string` | Message ID. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const id: string = appMessage.getId();\r\n      console.log(id);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getMessageType()\r\n\r\nObtains the message type.\r\n\r\n###### Return Type\r\n\r\n| Type          | Description                                                |\r\n| ------------- | ---------------------------------------------------------- |\r\n| `MessageType` | Message type. The banner message type is MessageType.CARD. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const messageType: MessageType = appMessage.getMessageType();\r\n      console.log(messageType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getStartTime()\r\n\r\nObtains the start timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                             |\r\n| -------- | ------------------------------------------------------- |\r\n| `number` | Start timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const startTime: number = appMessage.getStartTime();\r\n      console.log(startTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getEndTime()\r\n\r\nObtains the end timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                           |\r\n| -------- | ----------------------------------------------------- |\r\n| `number` | End timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const endTime: number = appMessage.getEndTime();\r\n      console.log(endTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyType()\r\n\r\nObtains the display frequency of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                                                                                                                                                           |\r\n| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `number` | Display frequency type of a message. The options are as follows: <br/>1: only once.<br/>2: once every X days. The value of X is the return value of getFrequencyValue.<br/>3: X days per day The value of X is the return value of getFrequencyValue. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyType: number = appMessage.getFrequencyType();\r\n      console.log(frequencyType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyValue()\r\n\r\nObtains the display frequency limit of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                        |\r\n| -------- | ------------------------------------------------------------------------------------------------------------------ |\r\n| `number` | Display frequency limit of an in-app message. This parameter is valid only when getFrequencyType is set to 2 or 3. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyValue: number = appMessage.getFrequencyValue();\r\n      console.log(frequencyValue);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTestFlag()\r\n\r\nChecks whether an in-app message is a test message.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                 |\r\n| ---------- | --------------------------------------------------------------------------------------------------------------------------- |\r\n| `TestFlag` | Checks whether an in-app message is a test message. The options are as follows:<br/>1: test message<br/>0: non-test message |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const testFlag: TestFlag = appMessage.getTestFlag();\r\n      console.log(testFlag);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTriggerEvents()\r\n\r\nA collection of in-app message trigger event types, which are selected by you in AppGallery Connect.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                                                                                                  |\r\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| `string[]` | A collection of in-app message trigger event types.The App Messaging SDK matches an event ID with the trigger event types of an in-app message. If the ID is in TriggerEvent, the message will be displayed. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const triggerEvents: string[] = appMessage.getTriggerEvents();\r\n      console.log(triggerEvents);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getCard()\r\n\r\nObtains the card information of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type   | Description                                       |\r\n| ------ | ------------------------------------------------- |\r\n| `Card` | Obtains the card information of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      console.log(JSON.stringify(card));\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n### 3.5. Card\r\n\r\nRepresents the card class in a pop-up message.\r\n\r\n#### Public Method Summary\r\n\r\n| Method                       | Return Type | Description                                                    |\r\n| ---------------------------- | ----------- | -------------------------------------------------------------- |\r\n| getTitle()                   | `string`    | Obtains the title of a pop-up message.                         |\r\n| getTitleColor()              | `string`    | Obtains the title color of a pop-up message.                   |\r\n| getTitleColorOpenness()      | `number`    | Obtains the title color transparency of a pop-up message.      |\r\n| getBody()                    | `string`    | Obtains the body of a pop-up message.                          |\r\n| getBodyColor()               | `string`    | Obtains the body color of a pop-up message.                    |\r\n| getBodyColorOpenness()       | `number`    | Obtains the body color transparency of a pop-up message.       |\r\n| getBackgroundColor()         | `string`    | Obtains the background color of a pop-up message.              |\r\n| getBackgroundColorOpenness() | `number`    | Obtains the background color transparency of a pop-up message. |\r\n| getPortraitPictureUrl()      | `string`    | Obtains the URL of the portrait image for a pop-up message.    |\r\n| getLandscapePictureUrl()     | `string`    | Obtains the URL of the landscape image for a pop-up message.   |\r\n| getMajorButton()             | `Button`    | Obtains the primary button of a pop-up message.                |\r\n| getMinorButton()             | `Button`    | Obtains the secondary button of a pop-up message.              |\r\n\r\n#### Public Methods\r\n\r\n##### getTitle()\r\n\r\nObtains the title of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                |\r\n| -------- | -------------------------- |\r\n| `string` | Title of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const title: string = card.getTitle();\r\n      console.log(title);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTitleColor()\r\n\r\nObtains the title color of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                      |\r\n| -------- | -------------------------------- |\r\n| `string` | Title color of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const titleColor: string = card.getTitleColor();\r\n      console.log(titleColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTitleColorOpenness()\r\n\r\nObtains the title color transparency of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                   |\r\n| -------- | --------------------------------------------- |\r\n| `number` | Title color transparency of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const titleColorOpenness: number = card.getTitleColorOpenness();\r\n      console.log(titleColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBody()\r\n\r\nObtains the body of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description               |\r\n| -------- | ------------------------- |\r\n| `string` | Body of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const body: string = card.getBody();\r\n      console.log(body);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBodyColor()\r\n\r\nObtains the body color of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                     |\r\n| -------- | ------------------------------- |\r\n| `string` | Body color of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const bodyColor: string = card.getBodyColor();\r\n      console.log(bodyColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBodyColorOpenness()\r\n\r\nObtains the body color transparency of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                  |\r\n| -------- | ---------------------------------------------------------------------------- |\r\n| `number` | Body color transparency of a pop-up message. The value ranges from 0 to 100. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const bodyColorOpenness: number = card.getBodyColorOpenness();\r\n      console.log(bodyColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBackgroundColor()\r\n\r\nObtains the background color of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                  |\r\n| -------- | ------------------------------------------------------------ |\r\n| `string` | Background color of a pop-up message, which is an RGB value. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const backgroundColor: string = card.getBackgroundColor();\r\n      console.log(backgroundColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getBackgroundColorOpenness()\r\n\r\nObtains the background color transparency of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                        |\r\n| -------- | ---------------------------------------------------------------------------------- |\r\n| `number` | Background color transparency of a pop-up message. The value ranges from 0 to 100. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const backgroundColorOpenness: string = card.getBackgroundColorOpenness();\r\n      console.log(backgroundColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getPortraitPictureUrl()\r\n\r\nObtains the URL of the portrait image for a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                     |\r\n| -------- | ----------------------------------------------- |\r\n| `string` | URL of the portrait image for a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const portraitPictureUrl: string = card.getPortraitPictureUrl();\r\n      console.log(portraitPictureUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getLandscapePictureUrl()\r\n\r\nObtains the URL of the landscape image for a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                      |\r\n| -------- | ------------------------------------------------ |\r\n| `string` | URL of the landscape image for a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const landscapePictureUrl: string = card.getLandscapePictureUrl();\r\n      console.log(landscapePictureUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getMajorButton()\r\n\r\nObtains the primary button of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                         |\r\n| -------- | ----------------------------------- |\r\n| `Button` | Primary button of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const majorButton: Button = card.getMajorButton();\r\n      console.log(JSON.stringify(majorButton));\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getMinorButton()\r\n\r\nObtains the secondary button of a pop-up message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                           |\r\n| -------- | ------------------------------------- |\r\n| `Button` | Secondary button of a pop-up message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const minorButton: Button = card.getMinorButton();\r\n      console.log(JSON.stringify(minorButton));\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n### 3.6. Button\r\n\r\nRepresents a pop-up message button.\r\n\r\n#### Public Method Summary\r\n\r\n| Method                 | Return Type | Description                                             |\r\n| ---------------------- | ----------- | ------------------------------------------------------- |\r\n| getText()              | `string`    | Obtains the button name.                                |\r\n| getTextColor()         | `string`    | Obtains the button name text color.                     |\r\n| getTextColorOpenness() | `number`    | Obtains the transparency of the button name text color. |\r\n| getActionUrl()         | `string`    | Obtains the redirection URL of the button.              |\r\n\r\n#### Public Methods\r\n\r\n##### getText()\r\n\r\nObtains the button name.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description  |\r\n| -------- | ------------ |\r\n| `string` | Button name. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const minorButton: Button = card.getMinorButton();\r\n      const text: string = minorButton.getText();\r\n      console.log(text);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTextColor()\r\n\r\nObtains the button name text color.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description             |\r\n| -------- | ----------------------- |\r\n| `string` | Button name text color. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const minorButton: Button = card.getMinorButton();\r\n      const textColor: string = minorButton.getTextColor();\r\n      console.log(textColor);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTextColorOpenness()\r\n\r\nObtains the transparency of the button name text color.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                 |\r\n| -------- | ------------------------------------------- |\r\n| `number` | Transparency of the button name text color. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const minorButton: Button = card.getMinorButton();\r\n      const textColorOpenness: string = minorButton.getTextColorOpenness();\r\n      console.log(textColorOpenness);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getActionUrl()\r\n\r\nObtains the redirection URL of the button.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                    |\r\n| -------- | ------------------------------ |\r\n| `string` | Redirection URL of the button. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const card: Card = appMessage.getCard();\r\n      const minorButton: Button = card.getMinorButton();\r\n      const actionUrl: string = minorButton.getActionUrl();\r\n      console.log(actionUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n### 3.7. PictureMessage\r\n\r\nRepresents an image message.\r\n\r\n#### Public Method Summary\r\n\r\n| Method              | Return Type   | Description                                         |\r\n| ------------------- | ------------- | --------------------------------------------------- |\r\n| getId()             | `string`      | Obtains the ID of an in-app message.                |\r\n| getMessageType()    | `MessageType` | Obtains the message type.                           |\r\n| getStartTime()      | `number`      | Obtains the start timestamp of a message.           |\r\n| getEndTime()        | `number`      | Obtains the end timestamp of a message.             |\r\n| getFrequencyType()  | `number`      | Obtains the display frequency type of a message.    |\r\n| getFrequencyValue() | `number`      | Obtains the display frequency of a message.         |\r\n| getTestFlag()       | `TestFlag`    | Checks whether an in-app message is a test message. |\r\n| getTriggerEvents()  | `string[]`    | Obtain the ID of a trigger event.                   |\r\n| getPicture()        | `Picture`     | Obtains the information of an image message.        |\r\n\r\n#### Public Methods\r\n\r\n##### getId()\r\n\r\nObtains the ID of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description |\r\n| -------- | ----------- |\r\n| `string` | Message ID. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const id: string = appMessage.getId();\r\n      console.log(id);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getMessageType()\r\n\r\nObtains the message type.\r\n\r\n###### Return Type\r\n\r\n| Type          | Description                                                   |\r\n| ------------- | ------------------------------------------------------------- |\r\n| `MessageType` | Message type. The banner message type is MessageType.PICTURE. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const messageType: MessageType = appMessage.getMessageType();\r\n      console.log(messageType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getStartTime()\r\n\r\nObtains the start timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                             |\r\n| -------- | ------------------------------------------------------- |\r\n| `number` | Start timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const startTime: number = appMessage.getStartTime();\r\n      console.log(startTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getEndTime()\r\n\r\nObtains the end timestamp of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                           |\r\n| -------- | ----------------------------------------------------- |\r\n| `number` | End timestamp of a message, accurate to milliseconds. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const endTime: number = appMessage.getEndTime();\r\n      console.log(endTime);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyType()\r\n\r\nObtains the display frequency of a message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                                                                                                                                                           |\r\n| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `number` | Display frequency type of a message. The options are as follows: <br/>1: only once.<br/>2: once every X days. The value of X is the return value of getFrequencyValue.<br/>3: X days per day The value of X is the return value of getFrequencyValue. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyType: number = appMessage.getFrequencyType();\r\n      console.log(frequencyType);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getFrequencyValue()\r\n\r\nObtains the display frequency limit of an in-app message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                                                                                                        |\r\n| -------- | ------------------------------------------------------------------------------------------------------------------ |\r\n| `number` | Display frequency limit of an in-app message. This parameter is valid only when getFrequencyType is set to 2 or 3. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const frequencyValue: number = appMessage.getFrequencyValue();\r\n      console.log(frequencyValue);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTestFlag()\r\n\r\nChecks whether an in-app message is a test message.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                 |\r\n| ---------- | --------------------------------------------------------------------------------------------------------------------------- |\r\n| `TestFlag` | Checks whether an in-app message is a test message. The options are as follows:<br/>1: test message<br/>0: non-test message |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const testFlag: TestFlag = appMessage.getTestFlag();\r\n      console.log(testFlag);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getTriggerEvents()\r\n\r\nA collection of in-app message trigger event types, which are selected by you in AppGallery Connect.\r\n\r\n###### Return Type\r\n\r\n| Type       | Description                                                                                                                                                                                                  |\r\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| `string[]` | A collection of in-app message trigger event types.The App Messaging SDK matches an event ID with the trigger event types of an in-app message. If the ID is in TriggerEvent, the message will be displayed. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const triggerEvents: string[] = appMessage.getTriggerEvents();\r\n      console.log(triggerEvents);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getPicture()\r\n\r\nObtains the information of an image message.\r\n\r\n###### Return Type\r\n\r\n| Type      | Description                      |\r\n| --------- | -------------------------------- |\r\n| `Picture` | Information of an image message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const picture: Picture = appMessage.getPicture();\r\n      console.log(JSON.stringify(picture));\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n### 3.8. Picture\r\n\r\nRepresents the information of an image message.\r\n\r\n#### Public Method Summary\r\n\r\n| Method          | Return Type | Description                                      |\r\n| --------------- | ----------- | ------------------------------------------------ |\r\n| getPictureUrl() | `string`    | Image URL of an image message.                   |\r\n| getActionUrl()  | `string`    | Obtains the redirection URL of an image message. |\r\n\r\n#### Public Methods\r\n\r\n##### getPictureUrl()\r\n\r\nImage URL of an image message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                    |\r\n| -------- | ------------------------------ |\r\n| `string` | Image URL of an image message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const picture: Picture = appMessage.getPicture();\r\n      const pictureUrl: string = picture.getPictureUrl();\r\n      console.log(pictureUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n\r\n##### getActionUrl()\r\n\r\nObtains the redirection URL of an image message.\r\n\r\n###### Return Type\r\n\r\n| Type     | Description                          |\r\n| -------- | ------------------------------------ |\r\n| `string` | Redirection URL of an image message. |\r\n\r\n###### Call Example\r\n\r\n```ts\r\nasync function example() {\r\n  await AGCAppMessaging.addListener(\r\n    Events.ON_MESSAGE_DISPLAY_LISTENER,\r\n    (appMessage) => {\r\n      const picture: Picture = appMessage.getPicture();\r\n      const actionUrl: string = picture.getActionUrl();\r\n      console.log(actionUrl);\r\n    }\r\n  );\r\n}\r\n```\r\n## 3.9. Constants\r\n\r\n### Enum MessageType\r\n\r\nObtains the message type.\r\n\r\n| Field      | Value | Description     |\r\n| ---------- | ----- | --------------- |\r\n| UN_SUPPORT | 0     | Undefined type. |\r\n| CARD       | 1     | Pop-up message. |\r\n| PICTURE    | 2     | Image message.  |\r\n| BANNER     | 3     | Banner message. |\r\n\r\n### Enum Location\r\n\r\nDisplay position of a pop-up or image message.\r\n\r\n| Field  | Value | Description |\r\n| ------ | ----- | ----------- |\r\n| BOTTOM | 0     | Bottom.     |\r\n| CENTER | 1     | Center.     |\r\n\r\n### Enum TestFlag\r\n\r\nTestFlag constants.\r\n\r\n| Field            | Value | Description       |\r\n| ---------------- | ----- | ----------------- |\r\n| NON_TEST_MESSAGE | 0     | Non-test message. |\r\n| TEST_MESSAGE     | 1     | Test message.     |\r\n\r\n### Enum DismissType\r\n\r\nMessage closing constants.\r\n\r\n| Field                | Value | Description                               |\r\n| -------------------- | ----- | ----------------------------------------- |\r\n| UNKNOWN_DISMISS_TYPE | 0     | Undefined type.                           |\r\n| CLICK                | 1     | Close button or redirection link tapping. |\r\n| CLICK_OUTSIDE        | 2     | Tapping outside the message borders.      |\r\n| BACK_BUTTON          | 3     | Back button tapping.                      |\r\n| AUTO                 | 4     | Auto.                                     |\r\n| SWIPE                | 5     | SWIPE.                                    |\r\n\r\n### Enum Events\r\n\r\nEvents constants for event callbacks.\r\n\r\n| Field                       | Value            | Description                        |\r\n| --------------------------- | ---------------- | ---------------------------------- |\r\n| ON_MESSAGE_CLICK_LISTENER   | onMessageClick   | Listens on message tap events.     |\r\n| ON_MESSAGE_DISPLAY_LISTENER | onMessageDisplay | Listens on message display events. |\r\n| ON_MESSAGE_DISMISS_LISTENER | onMessageDismiss | Listens on message closing events. |\r\n| ON_MESSAGE_ERROR_LISTENER   | onMessageError   | Listens on message error events.   |\r\n\r\n## 3.10. Data Types\r\n\r\n### BaseProperties\r\n\r\nRepresents common base properties among all message type.\r\n\r\n| Field          | Type       | Description                              |\r\n| -------------- | ---------- | ---------------------------------------- |\r\n| id             | `number`   | ID of an in-app message.                 |\r\n| startTime      | `number`   | Start timestamp of a message.            |\r\n| endTime        | `number`   | End timestamp of a message.              |\r\n| frequencyType  | `number`   | Display frequency type of a message.     |\r\n| frequencyValue | `number`   | Display frequency of a message.          |\r\n| testFlag       | `number`   | In-app message is a test message or not. |\r\n| triggerEvents  | `string[]` | IDs of a trigger events.                 |\r\n\r\n### BannerMessageProps\r\n\r\nRepresents the banner message object.\r\n\r\n| Field  | Type             | Description             |\r\n| ------ | ---------------- | ----------------------- |\r\n| base   | `BaseProperties` | Base properties object. |\r\n| banner | `BannerProps`    | Banner object.          |\r\n\r\n### BannerProps\r\n\r\nRepresents the information of a banner.\r\n\r\n| Field                   | Type     | Description                                        |\r\n| ----------------------- | -------- | -------------------------------------------------- |\r\n| base                    | `Probs`       | Message detail.                                    |\r\n| pictureURL              | `string` | Imag","readmeFilename":"README.md"}