Merge pull request #99 from jpush/dev

Dev
jpush · Feb 26, 2019 · 5b227c1 · 5b227c1
2 parents bac6013 + 73939e4
commit 5b227c1
Show file tree

Hide file tree

Showing 9 changed files with 2,045 additions and 2,223 deletions.
diff --git a/ionic/index.ts b/ionic/index.ts
diff --git a/ionic/jmessage/index.d.ts b/ionic/jmessage/index.d.ts
@@ -1,4 +1,25 @@
 import { IonicNativePlugin } from '@ionic-native/core';
+/**
+ * @name jmessage
+ * @description
+ * This plugin does something
+ *
+ * @usage
+ * ```typescript
+ * import { jmessage } from '@ionic-native/jmessage';
+ *
+ *
+ * constructor(private jmessage: jmessage) { }
+ *
+ * ...
+ *
+ *
+ * this.jmessage.functionName('Hello', 123)
+ *   .then((res: any) => console.log(res))
+ *   .catch((error: any) => console.error(error));
+ *
+ * ```
+ */
 export interface JMSingleType {
     type: 'single';
     username: string;
@@ -73,9 +94,9 @@ export declare type JMCustomMessage = JMNormalMessage & {
 export interface JMEventMessage {
     type: 'event';
     eventType: 'group_member_added' | 'group_member_removed' | 'group_member_exit';
-    usernames: JMUserInfo[];
+    usernames: string[];
 }
-export declare type JMAllMessage = JMTextMessage | JMVoiceMessage | JMImageMessage | JMFileMessage | JMEventMessage;
+export declare type JMAllMessage = JMTextMessage | JMVoiceMessage | JMImageMessage | JMFileMessage | JMEventMessage | JMCustomMessage;
 export declare type JMMessageEventListener = (message: JMAllMessage) => void;
 export declare type JMSyncOfflineMessageListener = (event: {
     conversation: JMConversationInfo;
@@ -217,7 +238,7 @@ export interface JMMessageSendOptions {
      */
     notificationText?: string;
 }
-export declare class JMChatRoom {
+export declare class JMChatRoomOriginal {
     getChatRoomInfoListOfApp(params: {
         start: number;
         count: number;
@@ -240,18 +261,14 @@ export declare class JMChatRoom {
     }, success: () => void, fail: (error: JMError) => void): void;
     getChatRoomConversationList(success: (conversationList: JMConversationInfo[]) => void, fail: (error: JMError) => void): void;
 }
-/**
- * @name jmessage
- * @description
- * This plugin does something
- */
-export declare class JMessagePlugin extends IonicNativePlugin {
+export declare class JMessagePluginOriginal extends IonicNativePlugin {
     /**
      * This function does something
-     * @param obj {string} Some param to configure something
+     * @param arg1 {string} Some param to configure something
      * @param arg2 {number} Another param to configure something
      * @return {Promise<any>} Returns a promise that resolves when something happens
      */
+    functionName(arg1: string, arg2: number): Promise<any>;
     init(params: JMConfig): void;
     setDebugMode(params: {
         enable: boolean;
@@ -563,3 +580,6 @@ export declare class JMessagePlugin extends IonicNativePlugin {
     addReceiveGroupAdminApprovalListener(params: JMReceiveGroupAdminApprovalListener): void;
     removeReceiveGroupAdminApprovalListener(params: JMReceiveGroupAdminApprovalListener): void;
 }
+
+export declare const JMChatRoom: JMChatRoomOriginal;
+export declare const JMessagePlugin: JMessagePluginOriginal;