Skip to content

Commit

Permalink
feat(baidu-push): add plugin (#2838)
Browse files Browse the repository at this point in the history
* Initial push.

* Revert tslint.json and switch imports around to be alphabetical.

* Remove non-used plugins to decrease build time.

* Finish the BaiduPush interface.

* Add observables.

* Restore other plugins.

* Restore file formatting.

* Update documentation.

* Update index.ts
  • Loading branch information
eric-horodyski authored and danielsogl committed Jan 4, 2019
1 parent 448e064 commit c3de8df
Showing 1 changed file with 187 additions and 0 deletions.
187 changes: 187 additions & 0 deletions src/@ionic-native/plugins/baidu-push/index.ts
@@ -0,0 +1,187 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs/Observable';

declare const baiduPush: any;

export interface BaiduResponse<T> {
/**
* The corresponding Baidu SDK method called.
*/
type: string;
/**
* The error code corresponding to Baidu's request.
*/
errorCode?: string;
/**
* Registration data revelvant to subsequent actions.
*/
data: T;
}

export interface RegistrationData {
/**
* The ID registered to Baidu for the app.
*/
appId: string;
/**
* The ID registered to Baidu for the device.
*/
userId: string;
/**
* The channel ID registered to Baidu for the app.
*/
channelId: string;
}

export interface UnregistrationData {
/**
* The ID corresponding to the Baidu request.
*/
requestId: string;
}

export interface TagData {
/**
* The ID corresponding to the Baidu request.
*/
requestId: string;
/**
* The channel ID registered to Baidu for the app.
*/
channelId: string;
/**
* The list of successfully set/deleted tags.
*/
sucessTags: string[];
/**
* The list of unsuccessfully set/deleted tags.
*/
failTags: string[];
}

export interface NotificationData {
/**
* The title of the notification.
*/
title: string;
/**
* The description of the notification.
*/
description: string;
/**
* Custom content for the notification.
*/
customContentString?: string;
}

/**
* @name Baidu Push
* @description
* This plugin faciliates the use of Baidu Push notifications.
*
* @usage
* ```typescript
* import { BaiduPush } from '@ionic-native/baidu-push';
*
*
* constructor(private baiduPush: BaiduPush) { }
*
* ...
*
* this.baiduPush.startWork('xxxxxx')
* .then((res: any) => console.log(res))
* .catch((error: any) => console.error(error));
*
* ```
* @interfaces
* BaiduResponse
* RegistrationData
* UnregistrationData
* TagData
* NotificationData
*/
@Plugin({
pluginName: 'BaiduPush',
plugin: 'cordova-plugin-push-baidu',
pluginRef: 'baiduPush',
repo: 'https://github.com/Ti-webdev/cordova-plugin-push-baidu.git',
platforms: ['Android', 'iOS']
})
@Injectable()
export class BaiduPush extends IonicNativePlugin {
/**
* This method registers the device to Baidu Cloud Push services.
* @param {string} apiKey Baidu Cloud Push API key.
* @return {Promise<BaiduResponse<RegistrationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova()
startWork(apiKey: string): Promise<BaiduResponse<RegistrationData>> {
return;
}

/**
* This method unregisters the device to Baidu Cloud Push services.
* @return {Promise<BaiduResponse<UnregistrationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova()
stopWork(): Promise<BaiduResponse<UnregistrationData>> {
return;
}

/**
* This method re-binds the device to Baidu Cloud Push services.
* @return {Promise<BaiduResponse<RegistrationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova()
resumeWork(): Promise<BaiduResponse<RegistrationData>> {
return;
}

/**
* This sets tags in the Baidu Cloud Push services.
* @param tags {any} tags The tags to set.
* @return {Promise<BaiduResponse<TagData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova()
setTags(tags: any): Promise<BaiduResponse<TagData>> {
return;
}

/**
* This sets tags in the Baidu Cloud Push services.
* @param tags {any} tags The tags to set.
* @return {Promise<BaiduResponse<TagData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova()
delTags(tags: any): Promise<BaiduResponse<TagData>> {
return;
}

/**
* This method is called when a notification is recieved on the foreground.
* @return {Promise<BaiduResponse<NotificationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova({ observable: true })
onMessage(): Observable<BaiduResponse<NotificationData>> {
return;
}

/**
* This method is called when the user taps a notification.
* @return {Promise<BaiduResponse<NotificationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova({ observable: true })
onNotificationClicked(): Observable<BaiduResponse<NotificationData>> {
return;
}

/**
* This method is called when a notification is recieved.
* @return {Promise<BaiduResponse<NotificationData>>} Returns a Promise that resolves with a BaiduResponse.
*/
@Cordova({ observable: true })
onNotificationArrived(): Observable<BaiduResponse<NotificationData>> {
return;
}
}

0 comments on commit c3de8df

Please sign in to comment.