github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-01-31 10:36:14 +08:00
Code Issues Projects Releases Wiki Activity

feat(MobileMessaging): add support for CustomEvents (#3373)

Browse Source 
* feat(MobileMessaging): add methods for CustomEvents support

* fix(MobileMessaging) change customAttributes type

* fix(MobileMessaging): change methods return type

Co-authored-by: Konstantin Latypov <Konstantin.Latypov@infobip.com>
This commit is contained in:
Konstantin 2020-04-09 14:34:19 +03:00 committed by GitHub
parent 739fe89400
commit 3af9c48f05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 54 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/@ionic-native/plugins/mobile-messaging/index.ts
View File

@ -16,6 +16,11 @@ export type Event =
| 'personalized'
| 'depersonalized';
export interface CustomEvent {
definitionId: string;
properties: Record<string, string | number | boolean>;
}
export interface Configuration {
/**
* The application code of your Application from Push Portal website
@ -73,7 +78,7 @@ export interface UserData {
phones?: string[];
emails?: string[];
tags?: string[];
customAttributes?: Record<string, string>;
customAttributes?: Record<string, string | number | boolean>;
}
export interface Installation {
@ -92,7 +97,7 @@ export interface Installation {
deviceTimezoneId?: string;
applicationUserId?: string;
deviceName?: string;
customAttributes?: Record<string, string>;
customAttributes?: Record<string, string | number | boolean>;
}
export interface UserIdentity {
@ -258,6 +263,53 @@ export class MobileMessaging extends IonicNativePlugin {
return;
}
/**
* Sends an event to the server eventually, handles possible errors and do retries for you.
*
* @name submitEvent
* @param {Object} eventData. An object containing event data
* {
* definitionId: "eventDefinitionId"
* properties: {
* "stringAttribute": "string",
* "numberAttribute": 1,
* "dateAttribute": "2020-02-26T09:41:57Z",
* "booleanAttribute": true
* }
* }
*/
@Cordova({
sync: true
})
submitEvent(event: CustomEvent): void {
return;
}
/**
* Sends an event to the server immediately.
* You have to handle possible connection or server errors, do retries yourself.
*
* @name submitEventImmediately
* @param {Object} eventData. An object containing event data
* {
* definitionId: "eventDefinitionId"
* properties: {
* "stringAttribute": "string",
* "numberAttribute": 1,
* "dateAttribute": "2020-02-26T09:41:57Z",
* "booleanAttribute": true
* }
* }
* @param {Function} callback will be called on result, you have to handle error and do retries yourself
*/
@Cordova({
observable: true
})
submitEventImmediately(event: CustomEvent): Promise<void> {
return;
}
/**
* Saves user data to the server.
*