@ray-js/api 1.7.70 → 1.7.71

package/@types/CommunityKit.d.ts

@@ -0,0 +1,154 @@
+/**
+ * CommunityKit
+ *
+ * @version 2.2.0
+ */
+declare namespace ty.community {
+  /**
+   * 获取房屋信息
+   * @public
+   * @since CommunityKit 2.0.1
+   * @platform iOS Android
+   */
+  export function getHouseInfo(params?: {
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 项目id
+       * @since CommunityKit 2.1.0
+       */
+      blockId: string
+      /**
+       * 房间id
+       * @since CommunityKit 2.1.0
+       */
+      treeId: string
+      /**
+       * 项目名称
+       * @since CommunityKit 2.1.0
+       */
+      blockName: string
+      /**
+       * 房间名称
+       * @since CommunityKit 2.1.0
+       */
+      treeName: string
+      /**
+       * 社区所在经度
+       * @since CommunityKit 2.1.0
+       */
+      longitude: number
+      /**
+       * 社区所在纬度
+       * @since CommunityKit 2.1.0
+       */
+      latitude: number
+      /**
+       * 房屋审核状态(人房关系)
+       * 0：待审核，10：审核失败，20：审核成功，30：已迁出
+       * @since CommunityKit 2.1.0
+       */
+      auditStatus: number
+      /**
+       * 是否为游客家庭
+       * @since CommunityKit 2.1.0
+       */
+      isGuest: boolean
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * PageEventInfo
+   * @public
+   * @since CommunityKit 2.0.3
+   * @platform iOS Android
+   */
+  export function onOpenMiniPage(
+    listener: (params: PageEventInfoParam) => void
+  ): void
+
+  /**
+   * PageEventInfo
+   * @public
+   * @since CommunityKit 2.0.3
+   * @platform iOS Android
+   */
+  export function offOpenMiniPage(
+    listener: (params: PageEventInfoParam) => void
+  ): void
+
+  /** @since CommunityKit 2.0.1 */
+  export interface GetHouseInfoResponse {
+    /**
+     * 项目id
+     * @since CommunityKit 2.0.1
+     */
+    blockId: string
+    /**
+     * 房间id
+     * @since CommunityKit 2.0.1
+     */
+    treeId: string
+    /**
+     * 项目名称
+     * @since CommunityKit 2.0.1
+     */
+    blockName: string
+    /**
+     * 房间名称
+     * @since CommunityKit 2.0.1
+     */
+    treeName: string
+    /**
+     * 社区所在经度
+     * @since CommunityKit 2.0.1
+     */
+    longitude: number
+    /**
+     * 社区所在纬度
+     * @since CommunityKit 2.0.1
+     */
+    latitude: number
+    /**
+     * 房屋审核状态(人房关系)
+     * 0：待审核，10：审核失败，20：审核成功，30：已迁出
+     * @since CommunityKit 2.0.1
+     */
+    auditStatus: number
+    /**
+     * 是否为游客家庭
+     * @since CommunityKit 2.0.1
+     */
+    isGuest: boolean
+  }
+
+  /** @since CommunityKit 2.0.3 */
+  export interface PageEventInfoParam {
+    /**
+     * type
+     * @since CommunityKit 2.0.3
+     */
+    type: string
+    /**
+     * url
+     * @since CommunityKit 2.0.3
+     */
+    url: string
+  }
+}