لطفاً
توجه داشته
باشید تمام
ویژگیها و
توابعی که
با عنوان
«منسوخشده»
(deprecated) مشخص
شدهاند،
صرفاً برای
سازگاری با
نسخههای
پیشین در
دسترس
هستند و در
نسخههای
آیندهی
lightdm-webkit2-greeter حذف
خواهند شد.
توسعهدهندگان
پوسته
نباید از
ویژگیها
یا توابع
منسوخشده
در کارهای
جدید
استفاده
کنند و برای
اطمینان از
تداوم
عملکرد
صحیح، باید
آثار موجود
را که از این
موارد
منسوخ
استفاده
میکنند
بهروزرسانی
نمایند.
توابع زیر
باید توسط
پوستهی
خوشآمدگو
ارائه شده و
روی شیء
سراسری «window»
قابل
فراخوانی
باشند.
show_prompt(text, type)
این تابع
زمانی
فراخوانی
میشود که LightDM
به هر دلیلی
نیاز به
اعلان
ورودی از
سوی کاربر
داشته
باشد،
مانند
درخواست
گذرواژه.
پارامتر «text»
متن اعلان
است، و
پارامتر «type»
یا «text» برای
یک اعلان
مرئی، یا
«password» برای
اعلانی است
که ورودی آن
باید پنهان
شود.
show_message(text, type)
این تابع
زمانی
فراخوانی
میشود که LightDM
نیاز به
نمایش
اطلاعاتی
به کاربر
داشته باشد.
پارامتر «text»
متن پیام
است، و
پارامتر «type»
یا «info» برای
پیامهای
اطلاعرسانی،
یا «error» برای
پیامهای
خطایی است
که LightDM با
آنها
مواجه شده
است.
authentication_complete()
این تابع
زمانی توسط
LightDM فراخوانی
میشود که
فرایند
احراز هویت
به پایان
رسیده
باشد.
autologin_timer_expired()
این تابع
زمانی توسط
LightDM فراخوانی
میشود که
زمانسنج
ورود
خودکار
کاربر
منقضی شده
باشد.
خوشآمدگو
باید
فرایند
احراز هویت
را
بازنشانی
کند.
توابع زیر
برای
فراخوانی
توسط
خوشآمدگو
جهت اجرای
عملیات در LightDM
در دسترس
هستند.
lightdm.authenticate(username)
نام
کاربری
کاربری را
که
میخواهیم
احراز هویت
را با آن
آغاز کنیم
مشخص
میکند.
توجه داشته
باشید که
اگر lightdm.authenticate را
بدون
آرگومان
فراخوانی
کنید، LightDM (از
طریق PAM) تابع
show_prompt() را برای
درخواست
نام کاربری
فراخوانی
خواهد کرد.
تابع
قدیمیتر
lightdm.start_authentication() منسوخ
شده است.
lightdm.authenticate_as_guest()
احراز
هویت به
عنوان
کاربر
مهمان.
lightdm.cancel_authentication()
احراز
هویت هر
کاربری را
که در حال
حاضر در
فرایند
احراز هویت
است لغو
میکند.
lightdm.cancel_autologin()
احراز
هویت کاربر
ورود
خودکار را
لغو میکند.
تابع
قدیمیتر
lightdm.cancel_timed_login() منسوخ
شده است.
lightdm.get_hint(hint_name)
مقدار
راهنمای (hint)
نامگذاریشده
ارائهشده
توسط LightDM را
برمیگرداند.
lightdm.suspend()
در صورتی
که
خوشآمدگو
اختیارات
لازم را
داشته
باشد،
سیستم را
معلق (suspend)
میکند.
lightdm.hibernate()
در صورتی
که
خوشآمدگو
اختیارات
لازم را
داشته
باشد،
سیستم را به
خواب
زمستانی (hibernate)
میبرد.
lightdm.start_session_sync(session)
پس از
اینکه LightDM
کاربر را با
موفقیت
احراز هویت
کرد، با
فراخوانی
این تابع
نشست کاربر
را آغاز
کنید.
پارامتر
«session» نشست
کاربرِ
احراز هویت
شده است. اگر
هیچ نشستی
ارسال
نشود،
کاربر
احراز هویت
شده با نشست
پیشفرض
سیستم آغاز
به کار
میکند.
تابع
قدیمیتر
lightdm.login(user, session) منسوخ
شده است.
lightdm.respond(text)
هنگامی
که LightDM
درخواست
ورودی کرد،
پاسخ را به LightDM
ارائه
میدهد.
تابع
منسوخشده
«provide_secret» نام
داشت. این
تابع
همچنان
برای
سازگاری با
گذشته در
دسترس است،
اما
توسعهدهندگان
خوشآمدگو
باید به
استفاده از
lightdm.respond() روی
بیاورند.
lightdm.restart()
در صورتی
که
خوشآمدگو
اختیارات
لازم را
داشته
باشد،
سیستم را
بازراهاندازی
(restart) میکند.
lightdm.set_language(lang)
زبان را
برای نشست
فعلی LightDM
تنظیم
میکند.
lightdm.shutdown()
در صورتی
که
خوشآمدگو
اختیارات
لازم را
داشته
باشد،
سیستم را
خاموش
میکند.
متغیرهای
در دسترس
درون
خوشآمدگو
عبارتند
از:
lightdm.authentication_user
String. نام
کاربریِ
کاربری که
در حال
احراز هویت
است، یا null در
صورتی که
هیچ احراز
هویتی در
جریان
نباشد.
lightdm.autologin_guest
Boolean. مشخص
میکند که
آیا کاربر
مهمان باید
برای ورود
خودکار
استفاده
شود یا خیر.
lightdm.autologin_timeout
Number. تعداد
ثانیههای
انتظار پیش
از ورود
خودکار به
سیستم.
متغیر
قدیمیتر
lightdm.timed_user_delay منسوخ
شده است.
lightdm.autologin_user
String. نام
حساب
کاربریای
که باید پس
از سپری شدن
زمان تأخیر
ورود
خودکار،
بهطور
خودکار
وارد شود.
متغیر
قدیمیتر
lightdm.timed_login_user منسوخ
شده است.
lightdm.can_hibernate
Boolean. آیا
سیستم توسط
خوشآمدگو
امکان رفتن
به خواب
زمستانی را
دارد یا
خیر.
lightdm.can_restart
Boolean. آیا
سیستم توسط
خوشآمدگو
امکان
بازراهاندازی
شدن را دارد
یا خیر.
lightdm.can_shutdown
Boolean. آیا
سیستم توسط
خوشآمدگو
امکان
خاموش شدن
را دارد یا
خیر.
lightdm.can_suspend
Boolean. آیا
سیستم توسط
خوشآمدگو
امکان معلق
شدن را دارد
یا خیر.
lightdm.default_session
String. نام
نشست
پیشفرض
(همانطور
که در lightdm.conf
پیکربندی
شده است).
lightdm.has_guest_account
Boolean. مشخص
میکند که
یک حساب
کاربری
مهمان برای
ورود در
دسترس است
یا خیر.
lightdm.hide_users
بولی (Boolean).
کل فهرست
کاربران
نباید
نمایش داده
شود.
lightdm.hostname
رشته (String).
نام میزبان
سیستم.
lightdm.is_authenticated
بولی (Boolean).
نشان
میدهد که
آیا کاربر
با موفقیت
احراز هویت
شده است یا
خیر.
lightdm.in_authentication
بولی (Boolean).
نشان
میدهد که
آیا lightdm در حال
حاضر در
مرحلهٔ
احراز هویت
است یا خیر.
lightdm.language
رشته (String).
زبان
انتخابشدهٔ
کنونی. نام
متغیر
قدیمیتر
lightdm.default_language منسوخ
شده است.
lightdm.layout
رشته (String).
نام چیدمان
صفحهکلید
فعال کنونی.
برای تغییر
چیدمان، یک
نام چیدمان
معتبر به
این متغیر
اختصاص
دهید. نام
متغیر
قدیمیتر
lightdm.default_layout منسوخ
شده است.
lightdm.layouts
آرایه (Array).
چیدمانهای
صفحهکلید
موجود روی
سیستم.
آرایهای
از اشیاء LightDMLayout
را
بازمیگرداند.
lightdm.num_users
عدد (Number).
تعداد
کاربرانی
که قادر به
ورود به
سیستم
هستند.
lightdm.select_guest
بولی (Boolean).
کاربر
مهمان باید
بهطور
پیشفرض
برای ورود
انتخاب
شود.
lightdm.select_user
رشته (String).
نام کاربری
که باید
بهطور
پیشفرض
برای ورود
انتخاب
شود.
lightdm.sessions
آرایه (Array).
نشستهای
موجود روی
سیستم.
آرایهای
از اشیاء LightDMSession
را
بازمیگرداند.
lightdm.users
آرایه (Array).
کاربرانی
که قادر به
ورود هستند.
آرایهای
از اشیاء LightDMUser
را
بازمیگرداند.
فراخوانیهای
زیر را
میتوان
برای
خواندن
کلیدهای
پیکربندی
از فایل
پیکربندی
lightdm-webkit2-greeter انجام
داد.
config.get_str(section, key)
مقدار
رشتهای
مرتبط با
کلید زیر
بخش "section" در
فایل
پیکربندی
را
بازمیگرداند.
config.get_num(section, key)
مقدار
عددی مرتبط
با کلید زیر
بخش "section" در
فایل
پیکربندی
را
بازمیگرداند.
config.get_bool(section, key)
مقدار
بولی مرتبط
با کلید زیر
بخش "section" در
فایل
پیکربندی
را
بازمیگرداند.
شیء greeterutil
دارای
توابع کمکی
است که به
منظور
آسانتر
کردن کار
سازندگان
پوسته
طراحی
شدهاند.
greeterutil.dirlist(path)
آرایهای
از
رشتههای
نام
فایلهای
موجود در
"path"، یا در
صورت عدم
وجود مسیر،
مقدار Null را
بازمیگرداند.
greeterutil.txt2html(txt)
یک تبدیل
ساده به HTML از
متن
دریافتشده
را
بازمیگرداند.
خطوط جدید
با <br>
جایگزین
میشوند و
نویسههای
&، <، > و " با
معادلهای HTML
خود
جایگزین
میگردند.
لطفاً
برای فهرست
کامل
فراخوانیهای
موجود به
مستندات LightDM API
مراجعه
کنید. ابزار
lightdm-webkit2-greeter تمام LightDM API
را
پیادهسازی
میکند.
/etc/lightdm/lightdm-webkit2-greeter.conf
فایل
کلیدی (Keyfile)
حاوی یک
کلید: webkit-theme. این
کلید باید
مشخص کند که
greeter از کدام
پوسته
استفاده
کند.