UNPKG

1.65 kBTypeScriptView Raw
1import { RequestEnvelope } from 'ask-sdk-model';
2export type ViewportProfile = 'HUB-ROUND-SMALL' | 'HUB-LANDSCAPE-SMALL' | 'HUB-LANDSCAPE-MEDIUM' | 'HUB-LANDSCAPE-LARGE' | 'MOBILE-LANDSCAPE-SMALL' | 'MOBILE-PORTRAIT-SMALL' | 'MOBILE-LANDSCAPE-MEDIUM' | 'MOBILE-PORTRAIT-MEDIUM' | 'TV-LANDSCAPE-XLARGE' | 'TV-PORTRAIT-MEDIUM' | 'TV-LANDSCAPE-MEDIUM' | 'UNKNOWN-VIEWPORT-PROFILE';
3export type ViewportOrientation = 'EQUAL' | 'LANDSCAPE' | 'PORTRAIT';
4export type ViewportSizeGroup = 'XSMALL' | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE';
5export type ViewportDpiGroup = 'XLOW' | 'LOW' | 'MEDIUM' | 'HIGH' | 'XHIGH' | 'XXHIGH';
6export declare const ViewportSizeGroupOrder: ViewportSizeGroup[];
7export declare const ViewportDpiGroupOrder: ViewportDpiGroup[];
8/**
9 * return the {@link ViewportOrientation} of given width and height value
10 * @param {number} width
11 * @param {number} height
12 * @return {ViewportOrientation}
13 */
14export declare function getViewportOrientation(width: number, height: number): ViewportOrientation;
15/**
16 * return the {@link ViewportSizeGroup} of given size value
17 * @param {number} size
18 * @return {ViewportSizeGroup}
19 */
20export declare function getViewportSizeGroup(size: number): ViewportSizeGroup;
21/**
22 * return the {@link ViewportDpiGroup} of given dpi value
23 * @param {number} dpi
24 * @return {ViewportDpiGroup}
25 */
26export declare function getViewportDpiGroup(dpi: number): ViewportDpiGroup;
27/**
28 * return the {@link ViewportProfile} of given request envelope
29 * @param {RequestEnvelope} requestEnvelope
30 * @return {ViewportProfile}
31 */
32export declare function getViewportProfile(requestEnvelope: RequestEnvelope): ViewportProfile;