From 1358411b80cfb5d93f4310e0a0162536fab01f01 Mon Sep 17 00:00:00 2001 From: Ibby Date: Tue, 6 Dec 2016 08:06:25 -0500 Subject: [PATCH] docs(3dtouch): complete interfaces docs --- src/plugins/3dtouch.ts | 82 ++++++++++++++++++++++++++++-------------- 1 file changed, 56 insertions(+), 26 deletions(-) diff --git a/src/plugins/3dtouch.ts b/src/plugins/3dtouch.ts index 8d599562a..894753450 100644 --- a/src/plugins/3dtouch.ts +++ b/src/plugins/3dtouch.ts @@ -3,6 +3,59 @@ import { Observable } from 'rxjs/Observable'; declare var window: any; +export interface ThreeDeeTouchQuickAction { + + /** + * Type that can be used in the onHomeIconPressed callback + */ + type?: string; + + /** + * Title + */ + title: string; + + /** + * Subtitle + */ + subtitle?: string; + + /** + * Icon type. Case insensitive + */ + iconType?: string; + + /** + * Icon template + */ + iconTemplate?: string; + +} + +export interface ThreeDeeTouchForceTouch { + + /** + * Touch force + */ + force: number; + + /** + * Timestamp of action + */ + timestamp: number; + + /** + * X coordinate of action + */ + x: number; + + /** + * Y coordinate of action + */ + y: number; + +} + /** * @name 3DTouch * @description @@ -62,6 +115,9 @@ declare var window: any; * } * ) * ``` + * @interfaces + * ThreeDeeTouchQuickAction + * ThreeDeeTouchForceTouch */ @Plugin({ pluginName: 'ThreeDeeTouch', @@ -134,29 +190,3 @@ export class ThreeDeeTouch { static disableLinkPreview(): void { } } - -export interface ThreeDeeTouchQuickAction { - - type?: string; - - title: string; - - subtitle?: string; - - iconType?: string; - - iconTemplate?: string; - -} - -export interface ThreeDeeTouchForceTouch { - - force: number; - - timestamp: number; - - x: number; - - y: number; - -}