n
The greeter's Theme JavaScript API.
The greeter's Theme JavaScript API.
Base class for the greeter's Theme JavaScript API. Greeter themes will interact
directly with an object derived from this class to facilitate the user log-in process.
The greeter will automatically create an instance when it starts.
The instance can be accessed using the global variable: lightdm
.
Starts the authentication procedure for a user.
Starts the authentication procedure for the guest user.
The username of the user being authenticated or null if there is no authentication in progress.
Whether or not the guest account should be automatically logged into when the timer expires.
The number of seconds to wait before automatically logging in.
The username with which to automatically log in when the timer expires.
Whether or not the greeter can make the system hibernate.
Whether or not the greeter can make the system restart.
Whether or not the greeter can make the system shutdown.
Whether or not the greeter can make the system suspend/sleep.
Cancel the user authentication that is currently in progress.
Cancel the automatic login.
The name of the default session.
Get the value of a hint.
The name of the hint to get.
Whether or not guest sessions are supported.
Triggers the system to hibernate.
Whether or not user accounts should be hidden.
The system's hostname.
Whether or not the greeter is in the process of authenticating.
Whether or not the greeter has successfully authenticated.
The current language or null if no language.
A list of languages to present to the user.
The currently active layout for the selected user.
Set the active layout for the selected user.
A list of keyboard layouts to present to the user.
Whether or not the greeter was started as a lock screen.
The number of users able to log in.
Provide a response to a prompt.
Triggers the system to restart.
Whether or not the guest account should be selected by default.
The username to select by default.
List of available sessions.
Set the language for the currently authenticated user.
The language in the form of a locale specification (e.g. 'de_DE.UTF-8')
Triggers the system to shutdown.
Start a session for the authenticated user.
Triggers the system to suspend/sleep.
List of available users.
Provides greeter themes with a way to access values from the greeter's config
file located at /etc/lightdm/lightdm-webkit2-greeter.conf
. The greeter will
create an instance of this class when it starts. The instance can be accessed
with the global variable: greeter_config
.
Holds keys/values from the branding
section of the config file.
Path to directory that contains background images for use in greeter themes.
Path to distro logo image for use in greeter themes.
Default user image/avatar. This is used by greeter themes
for users that have not configured a .face
image.
Deprecated! Access config sections directly as properties of this object instead.
Config value for key
.
Deprecated! Access config sections directly as properties of this object instead.
Config value for key
.
Deprecated! Access config sections directly as properties of this object instead.
Config value for key
.
Holds keys/values from the greeter
section of the config file.
Greeter theme debug mode.
Provide an option to load a fallback theme when theme errors are detected.
Blank the screen after this many seconds of inactivity.
Don't allow themes to make remote http requests.
A moment.js format string to be used by the greeter to generate localized time for display.
Language to use when displaying the time or auto
to use the system's language.
The name of the theme to be used by the greeter.
Interface for object that holds info about a language on the system. Language objects are not
created by the theme's code, but rather by the LightDM.Greeter
class.
The code for the language.
The name for the layout.
The territory for the language.
Interface for object that holds info about a keyboard layout on the system. Language
objects are not created by the theme's code, but rather by the LightDM.Greeter
class.
The description for the layout.
The name for the layout.
The territory for the layout.
Interface for object that holds info about a session. Session objects are not
created by the theme's code, but rather by the LightDM.Greeter
class.
The comment for the session.
The key for the session.
The name for the session.
Provides various utility methods for use in greeter themes. The greeter will automatically
create an instance of this class when it starts. The instance can be accessed
with the global variable: theme_utils
.
Binds this
to class, context
, for all of the class's methods.
An ES6 class instance with at least one method.
context
with this
bound to it for all of its methods.
Returns the contents of directory found at path
provided that the (normalized) path
meets at least one of the following conditions:
/var/lib/lightdm-data
)./tmp
.Escape HTML entities in a string.
The text to be escaped.
Get the current time in a localized format. Time format and language are auto-detected by default, but can be set manually in the greeter config file.
language
defaults to the system's language, but can be set manually in the config file.time_format
config file option has a valid value, time will be formatted
according to that value.time_format
does not have a valid value, the time format will be LT
which is 1:00 PM
or 13:00
depending on the system's locale.The current localized time.
Use window.theme_utils.esc_html() instead.
Interface for object that holds info about a user account on the system. User
objects are not created by the theme's code, but rather by the LightDM.Greeter
class.
The display name for the user.
The home_directory for the user.
The image for the user.
The language for the user.
The keyboard layout for the user.
Whether or not the user is currently logged in.
Deprecated! See LightDM.User#username.
Deprecated! See LightDM.User#display_name.
The last session that the user logged into.
The username for the user.
The global window object.
No description available.
JS-Cookie instance - Themes must manually load the included vendor script in order to use this object.
Deprecated! Use window.greeter_config instead.
Greeter Config - Access values from the greeter's config file.
Deprecated! Use window.theme_utils instead.
jQuery instance - Themes must manually load the included vendor script in order to use this object.
Greeter Instance
Moment.js instance - Loaded and instantiated automatically by the greeter.
Theme Utils - various utility methods for use in greeter themes.