-
Notifications
You must be signed in to change notification settings - Fork 0
/
liferay.d.ts
91 lines (77 loc) · 1.57 KB
/
liferay.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
declare const Liferay: {
Language: LiferayLanguage
Util: LiferayUtil
ThemeDisplay: LiferayThemeDisplay
/**
* Get the authentication token
*/
authToken: string
}
interface LiferayLanguage {
/**
* Get language property value by a specified key and replace placeholders
* with values
*
* @param key
* @param params
*/
get: (key: string, params?: Array<string> | string) => string
/**
* Get all available language keys
*/
available: string[]
}
interface LiferayThemeDisplay {
/**
* Check if a user is currently impersonated
*/
isImpersonated: () => boolean
/**
* Get the encoded do as user id
*/
getDoAsUserIdEncoded: () => string
/**
* Check if the user is signed in
*/
isSignedIn: () => string
/**
* Get the current language id
*/
getLanguageId: () => 'en_US' | 'de_DE' | 'fr_FR' | 'it_IT'
/**
* Get the current plid
*/
getPlid: () => string
/**
* Get the current group id
*/
getScopeGroupId: () => string
/**
* Get the relative url of the current layout
*/
getLayoutRelativeURL: () => string
}
interface LiferayUtil {
/**
* Open a liferay toast
*
* @param title the title of the toast
* @param message the message of the toast
* @param type the type of the toast
*/
openToast: ({ title, message, type }: ToastParams) => void
}
interface ToastParams {
/**
* The title of the toast
*/
title: string
/**
* The message of the toast
*/
message: string
/**
* The type of the toast
*/
type: 'info' | 'error' | 'danger' | 'success'
}