mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-31 18:49:43 +08:00
feat(intercom): add Intercom plugin (#1504)
This commit is contained in:
parent
5ee79b4672
commit
ce2cc1b815
158
src/@ionic-native/plugins/intercom/index.ts
Normal file
158
src/@ionic-native/plugins/intercom/index.ts
Normal file
@ -0,0 +1,158 @@
|
||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||
import { Injectable } from '@angular/core';
|
||||
|
||||
/**
|
||||
* @name Intercom
|
||||
* @description
|
||||
* This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android.
|
||||
* Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/docs/cordova-phonegap-configuration
|
||||
*
|
||||
* @usage
|
||||
* ```typescript
|
||||
* import { Intercom } from '@ionic-native/intercom';
|
||||
*
|
||||
*
|
||||
* constructor(private intercom: Intercom) { }
|
||||
*
|
||||
* ...
|
||||
*
|
||||
* this.intercom.registerUnidentifiedUser();
|
||||
* ...
|
||||
* this.intercom.registerForPush();
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Intercom',
|
||||
plugin: 'cordova-plugin-intercom',
|
||||
pluginRef: 'intercom',
|
||||
repo: 'https://github.com/intercom/intercom-cordova',
|
||||
platforms: ['Android', 'iOS'],
|
||||
})
|
||||
@Injectable()
|
||||
export class Intercom extends IonicNativePlugin {
|
||||
|
||||
/**
|
||||
* Register a identified user
|
||||
* @param options {any} Options
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
registerIdentifiedUser(options: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Register a unidentified user
|
||||
* @param options {any} Options
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
registerUnidentifiedUser(options: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* This resets the Intercom integration's cache of your user's identity and wipes the slate clean.
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
reset(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param secureHash {string}
|
||||
* @param secureData {any}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
setSecureMode(secureHash: string, secureData: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param secureHash {string}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
setUserHash(secureHash: string): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param attributes {any}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
updateUser(attributes: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param eventName {string}
|
||||
* @param metaData {any}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
logEvent(eventName: string, metaData: any): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
displayMessenger(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
displayMessageComposer(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param initialMessage {string}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
displayMessageComposerWithInitialMessage(initialMessage: string): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
displayConversationsList(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
unreadConversationCount(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param visibility {string}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
setLauncherVisibility(visibility: string): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @param visibility {string}
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
setInAppMessageVisibility(visibility: string): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
hideMessenger(): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
*
|
||||
* @return {Promise<any>} Returns a promise
|
||||
*/
|
||||
@Cordova()
|
||||
registerForPush(): Promise<any> { return; }
|
||||
|
||||
}
|
Loading…
Reference in New Issue
Block a user