.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "org.bluez.Agent" "5" "October 2023" "BlueZ" "Linux System Administration"
.SH "نام (NAME)"
org.bluez.Agent \- مستندات واسط کاربری عامل احراز هویت بلوتوث
.SH "واسط (INTERFACE)"
.INDENT 0.0
.TP
.B سرویس (Service)
نام یکتا (unique name)
.TP
.B واسط (Interface)
org.bluez.Agent1
.TP
.B مسیر شیء (Object path)
قابل تعریف به صورت آزاد (freely definable)
.UNINDENT
.SS "روش‌ها (METHODS)"
.SS void Release()
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP ثبت عامل (agent) را لغو کند.
.sp
یک عامل می‌تواند از آن برای انجام وظایف پاک‌سازی استفاده کند. نیازی به لغو ثبت عامل نیست، زیرا هنگام فراخوانی این متد، ثبت آن از پیش لغو شده است.
.SS string RequestPinCode(object device)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP برای یک احراز هویت نیاز به دریافت کلید عبور (passkey) داشته باشد.
.sp
مقدار بازگشتی باید رشته‌ای به طول ۱\-۱۶ نویسه باشد. این رشته می‌تواند حرفی\-عددی (alphanumeric) باشد.
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS void DisplayPinCode(object device, string pincode)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP نیاز به نمایش یک پین‌کد (pincode) برای احراز هویت داشته باشد.
.sp
باید یک پاسخ خالی بازگردانده شود. هنگامی که دیگر نیازی به نمایش پین‌کد نباشد، متد Cancel عامل فراخوانی خواهد شد.
.sp
این متد در طول فرایند جفت‌سازی صفحه‌کلیدهایی استفاده می‌شود که از «جفت‌سازی ساده و امن» (Secure Simple Pairing) بلوتوث ۲.۱ پشتیبانی نمی‌کنند، در مقابل DisplayPasskey که برای صفحه‌کلیدهای دارای این قابلیت به کار می‌رود.
.sp
این متد همواره تنها یک بار فراخوانی خواهد شد، زیرا صفحه‌کلیدهای قدیمی‌تر از اعلان تایپ (typing notification) پشتیبانی نمی‌کنند.
.sp
توجه داشته باشید که PIN همواره یک عدد ۶\-رقمی خواهد بود که با افزودن صفر به سمت چپ به ۶ رقم تکمیل می‌شود (zero\-padded). این کار برای هماهنگی با مشخصات نسخه‌های بعدی است.
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS uint32 RequestPasskey(object device)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP برای یک احراز هویت نیاز به دریافت کلید عبور (passkey) داشته باشد.
.sp
مقدار بازگشتی باید یک مقدار عددی بین ۰\-۹۹۹۹۹۹ باشد.
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS void DisplayPasskey(object device, uint32 passkey, uint16 entered)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP نیاز به نمایش یک کلید عبور (passkey) برای احراز هویت داشته باشد.
.sp
پارامتر entered نشان‌دهنده تعداد کلیدهای تایپ‌شده تاکنون در طرف راه دور است.
.sp
باید یک پاسخ خالی بازگردانده شود. هنگامی که دیگر نیازی به نمایش کلید عبور نباشد، متد Cancel عامل فراخوانی خواهد شد.
.sp
در طول فرایند جفت‌سازی ممکن است این متد چندین بار فراخوانی شود تا مقدار entered به‌روزرسانی گردد.
.sp
توجه داشته باشید که کلید عبور همواره یک عدد ۶\-رقمی خواهد بود، بنابراین اگر مقدار کمتر از ۶ رقم داشته باشد، نمایش آن در ابتدا باید با صفر تکمیل شود (zero\-padded).
.SS void RequestConfirmation(object device, uint32 passkey)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP نیاز به تأیید یک کلید عبور برای احراز هویت داشته باشد.
.sp
برای تأیید مقدار، باید یک پاسخ خالی بازگردانده شود، یا در صورتی که کلید عبور نامعتبر باشد، یک خطا بازگردانده شود.
.sp
توجه داشته باشید که کلید عبور همواره یک عدد ۶\-رقمی خواهد بود، بنابراین اگر مقدار کمتر از ۶ رقم داشته باشد، نمایش آن در ابتدا باید با صفر تکمیل شود (zero\-padded).
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS void RequestAuthorization(object device)
.sp
این متد برای درخواست از کاربر جهت مجاز کردن تلاش جفت‌سازی ورودی فراخوانی می‌شود که در شرایط دیگر مدل just\-works را فعال می‌کرد، یا زمانی که کاربر دستگاهی را متصل کرده است که جفت‌سازی کابلی (cable pairing) را پیاده‌سازی می‌کند. در حالت دوم، دستگاه هنوز از طریق بلوتوث به آداپتور متصل نشده است.
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS void AuthorizeService(object device, string uuid)
.sp
این متد زمانی فراخوانی می‌شود که \fBbluetoothd(8)\fP نیاز به مجاز کردن یک درخواست اتصال/سرویس داشته باشد.
.sp
خطاهای احتمالی:
.INDENT 0.0
.TP
.B org.bluez.Error.Rejected
.TP
.B org.bluez.Error.Canceled
.UNINDENT
.SS void Cancel()
.sp
این متد برای نشان دادن اینکه درخواست عامل پیش از بازگرداندن پاسخ با شکست مواجه شده است، فراخوانی می‌شود.
.\" End of generated man page.