chrome.networking.onc

תיאור

ה-API של chrome.networking.onc משמש להגדרת חיבורים לרשת (סלולר, אתרנט, VPN או Wi-Fi). ה-API הזה זמין בסשנים של קיוסק ב-ChromeOS שמופעלים באופן אוטומטי.

הגדרות החיבור לרשת נקבעות לפי המפרט של Open Network Configuration (ONC).

NOTE: רוב מאפייני המילון וערכי ה-enum משתמשים ב-UpperCamelCase כדי להתאים למפרט ה-ONC במקום למוסכמה lowerCamelCase של JavaScript.

הרשאות

networking.onc

זמינות

Chrome 59 ואילך ChromeOS בלבד

סוגים

ActivationStateType

טיפוסים בני מנייה (enum)

"Activated"

"בהפעלה"

"NotActivated"

"PartiallyActivated"

CaptivePortalStatus

טיפוסים בני מנייה (enum)

"לא ידוע"

"אופליין"

"אונליין"

"Portal"

"ProxyAuthRequired"

CellularProperties

מאפיינים

  • ActivationState

    ActivationStateType אופציונלי

    מצב ההפעלה של חשבון הספק.

  • ActivationType

    מחרוזת אופציונלי

    סוג ההפעלה של הרשת הסלולרית.

  • AllowRoaming

    בוליאני אופציונלי

    אם מותרת נדידה ברשת.

  • AutoConnect

    בוליאני אופציונלי

    אם הרשת הסלולרית צריכה להתחבר באופן אוטומטי (כשהיא בטווח).

  • מינוי משפחתי

    מחרוזת אופציונלי

    משפחת הטכנולוגיה של המכשיר הסלולרי – CDMA או GSM.

  • FirmwareRevision

    מחרוזת אופציונלי

    גרסת הקושחה שנטענה במודם הסלולרי.

  • FoundNetworks

    ‫FoundNetworkProperties[] אופציונלי

    רשימת הרשתות שנמצאו במהלך סריקת הרשת האחרונה.

  • HardwareRevision

    מחרוזת אופציונלי

    גרסת החומרה של המודם הסלולרי.

  • HomeProvider

    CellularProviderProperties אופציונלי

    מידע על המפעיל שהנפיק את כרטיס ה-SIM שמותקן כרגע במודם.

  • היצרן

    מחרוזת אופציונלי

    היצרן של המודם הסלולרי.

  • ModelID

    מחרוזת אופציונלי

    מזהה הדגם של המודם הסלולרי.

  • NetworkTechnology

    מחרוזת אופציונלי

    אם המודם רשום ברשת, טכנולוגיית הרשת שנמצאת כרגע בשימוש.

  • PaymentPortal

    ‫PaymentPortal אופציונלי

    פורטל תשלומים אונליין שבו המשתמשים יכולים להירשם לחבילת גלישה או לשנות אותה.

  • RoamingState

    מחרוזת אופציונלי

    מצב הנדידה של המודם הסלולרי ברשת הנוכחית.

  • SIMLockStatus

    SIMLockStatus אופציונלי

    מצב נעילת כרטיס ה-SIM ברשתות ממשפחת GSM.

  • SIMPresent

    בוליאני אופציונלי

    אם יש כרטיס SIM.

  • סריקה

    בוליאני אופציונלי

    Chrome 63 ואילך

    הערך הוא True כשמתבצעת סריקה של רשת סלולרית.

  • ServingOperator

    CellularProviderProperties אופציונלי

    מידע על המפעיל שהמודם רשום כרגע ברשת שלו.

  • SignalStrength

    מספר אופציונלי

    עוצמת האות של הרשת הנוכחית.

  • SupportNetworkScan

    בוליאני אופציונלי

    אם הרשת הסלולרית תומכת בסריקה.

CellularProviderProperties

מאפיינים

  • קוד

    מחרוזת

    מזהה הרשת הסלולרית הוא שרשור פשוט של קוד המדינה של הרשת הסלולרית (MCC) וקוד הרשת הסלולרית (MNC).

  • מדינה

    מחרוזת אופציונלי

    קוד מדינה בן 2 אותיות.

  • שם

    מחרוזת

    שם המפעיל.

CellularStateProperties

מאפיינים

CertificatePattern

מאפיינים

  • EnrollmentURI

    string[] אופציונלי

    רשימת מזהי URI שאליהם אפשר להפנות את המשתמש אם לא נמצאו אישורים שתואמים לתבנית הזו.

  • המוסד המנפיק

    IssuerSubjectPattern אופציונלי

    אם המדיניות מוגדרת, התבנית שאליה צריך להתאים את הגדרות המנפיק של X.509.

  • IssuerCARef

    string[] אופציונלי

    רשימה של אישורי CA של מנפיק האישורים. כדי להתאים לתבנית הזו, האישור צריך להיות חתום על ידי אחת מהן.

  • נושא

    ‫IssuerSubjectPattern אופציונלי

    אם המדיניות מוגדרת, היא קובעת את התבנית שלפיה צריך להתאים את הגדרות הנושא של X.509.

ClientCertificateType

טיפוסים בני מנייה (enum)

"Ref"

"תבנית"

ConnectionStateType

טיפוסים בני מנייה (enum)

"מחובר"

"מתחבר"

"NotConnected"

DeviceStateProperties

מאפיינים

  • SIMLockStatus

    SIMLockStatus אופציונלי

    Chrome 62 ואילך

    סטטוס נעילת כרטיס ה-SIM אם Type = Cellular ו-SIMPresent = True.

  • SIMPresent

    בוליאני אופציונלי

    Chrome 62 ואילך

    אם סוג המכשיר הוא "סלולרי", צריך להגדיר את המצב הנוכחי של כרטיס ה-SIM.

  • סריקה

    בוליאני אופציונלי

    הגדרה אם המכשיר מופעל. אם המכשיר סורק כרגע, התנאי מתקיים.

  • מדינה (State)

    המצב הנוכחי של המכשיר.

  • סוג

    סוג הרשת שמשויכת למכשיר (סלולרית, אתרנט או Wi-Fi).

DeviceStateType

טיפוסים בני מנייה (enum)

"Uninitialized"
המכשיר זמין אבל לא אותחל.

"מושבת"
המכשיר מאותחל אבל לא מופעל.

"בתהליך הפעלה"
התקבלה בקשה להפעיל את המצב, אבל התהליך לא הושלם.

"מופעל"
המכשיר מופעל.

"אסור"
המכשיר אסור.

EAPProperties

מאפיינים

  • AnonymousIdentity

    מחרוזת אופציונלי

  • ClientCertPKCS11Id

    מחרוזת אופציונלי

    ‫Chrome מגרסה 60 ואילך
  • ClientCertPattern

    CertificatePattern אופציונלי

  • ClientCertProvisioningProfileId

    מחרוזת אופציונלי

    ‫Chrome 93 ואילך
  • ClientCertRef

    מחרוזת אופציונלי

  • ClientCertType
  • זהויות

    מחרוזת אופציונלי

  • מסגרת פנימית

    מחרוזת אופציונלי

  • מסגרת חיצונית

    מחרוזת אופציונלי

    סוג ה-EAP החיצוני. נדרש על ידי ONC, אבל יכול להיות שלא יסופק בתרגום מ-Shill.

  • סיסמה

    מחרוזת אופציונלי

  • SaveCredentials

    בוליאני אופציונלי

  • ServerCAPEMs

    string[] אופציונלי

  • ServerCARefs

    string[] אופציונלי

  • SubjectMatch

    ManagedDOMString אופציונלי

    ‫Chrome מגרסה 60 ואילך
  • UseProactiveKeyCaching

    בוליאני אופציונלי

  • UseSystemCAs

    בוליאני אופציונלי

EthernetProperties

מאפיינים

  • אימות

    מחרוזת אופציונלי

    האימות שבו משתמשת רשת האתרנט. הערכים האפשריים הם None ו-8021X.

  • AutoConnect

    בוליאני אופציונלי

    אם רשת האתרנט צריכה להתחבר באופן אוטומטי.

  • EAP

    ‫EAPProperties אופציונלי

    הגדרות ה-EAP של הרשת. נדרש לאימות 8021X.

EthernetStateProperties

מאפיינים

FoundNetworkProperties

מאפיינים

  • LongName

    מחרוזת אופציונלי

    השם של מפעיל הרשת בפורמט ארוך.

  • NetworkId

    מחרוזת

    מזהה הרשת.

  • ShortName

    מחרוזת אופציונלי

    השם המקוצר של מפעיל הרשת.

  • סטטוס

    מחרוזת

    זמינות הרשת.

  • טכנולוגיה

    מחרוזת

    טכנולוגיית הגישה שבה הרשת משתמשת.

GlobalPolicy

מאפיינים

  • AllowOnlyPolicyNetworksToAutoconnect

    בוליאני אופציונלי

    אם המדיניות מוגדרת כ-True, רק רשתות שמוגדרות במדיניות יכולות להתחבר באופן אוטומטי. ברירת המחדל היא False.

  • AllowOnlyPolicyNetworksToConnect

    בוליאני אופציונלי

    אם הערך הוא True, אפשר להתחבר רק לרשתות שמוגדרות במדיניות, ואי אפשר להוסיף או להגדיר רשתות חדשות. ברירת המחדל היא False.

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    בוליאני אופציונלי

    Chrome 70 ואילך

    אם המדיניות מוגדרת כ-True ורשת מנוהלת זמינה ברשימת הרשתות הגלויות, אפשר להתחבר רק לרשתות שמוגדרות במדיניות ואי אפשר להוסיף או להגדיר רשתות חדשות. ברירת המחדל היא False.

  • BlockedHexSSIDs

    string[] אופציונלי

    ‫Chrome מגרסה 86 ואילך

    רשימת הרשתות החסומות. אסור להתחבר לרשתות חסומות. כדי לבטל את החסימה של הרשתות, צריך לציין הגדרת רשת מפורשת. ברירת המחדל היא רשימה ריקה.

IPConfigProperties

מאפיינים

  • ExcludedRoutes

    string[] אופציונלי

    ‫Chrome מגרסה 76 ואילך

    מערך של בלוקים של כתובות IP בסימון CIDR, פרטים נוספים זמינים ב-onc_spec.md.

  • שער

    מחרוזת אופציונלי

    כתובת השער שמשמשת להגדרת ה-IP.

  • IPAddress

    מחרוזת אופציונלי

    כתובת ה-IP של החיבור. יכולה להיות כתובת IPv4 או IPv6, בהתאם לערך של Type.

  • IncludedRoutes

    string[] אופציונלי

    ‫Chrome מגרסה 76 ואילך

    מערך של בלוקים של כתובות IP בסימון CIDR, פרטים נוספים זמינים ב-onc_spec.md.

  • NameServers

    string[] אופציונלי

    מערך של כתובות שמשמשות לשרתי שמות.

  • RoutingPrefix

    מספר אופציונלי

    קידומת הניתוב.

  • SearchDomains

    string[] אופציונלי

    ‫Chrome מגרסה 76 ואילך

    מערך של מחרוזות לתרגום שם (name resolution), פרטים נוספים זמינים ב-onc_spec.md.

  • סוג

    מחרוזת אופציונלי

    סוג הגדרת ה-IP. הערך יכול להיות IPv4 או IPv6.

  • WebProxyAutoDiscoveryUrl

    מחרוזת אופציונלי

    כתובת ה-URL של פרוטוקול Web Proxy Auto-Discovery ‏(WPAD), כפי שדווחה דרך DHCP.

IPConfigType

טיפוסים בני מנייה (enum)

"DHCP"

"סטטי"

IssuerSubjectPattern

מאפיינים

  • CommonName

    מחרוזת אופציונלי

    אם מוגדר, הערך שלפיו יתבצע האימות של השם הנפוץ של נושא האישור.

  • ישוב

    מחרוזת אופציונלי

    אם מוגדר, הערך שלפיו תתבצע ההתאמה למיקום הנפוץ של נושא האישור.

  • ארגון

    מחרוזת אופציונלי

    אם המדיניות מוגדרת, הערך שלפיו מתבצעת ההתאמה לארגונים של נושא האישור. לפחות ארגון אחד צריך להתאים לערך.

  • OrganizationalUnit

    מחרוזת אופציונלי

    אם מוגדר, הערך שלפיו יותאמו היחידות הארגוניות של נושא האישור. לפחות יחידה ארגונית אחת צריכה להתאים לערך.

ManagedBoolean

מאפיינים

  • פעילה

    בוליאני אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    בוליאני אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    בוליאני אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. השדה הזה מופיע רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    בוליאני אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    בוליאני אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedCellularProperties

מאפיינים

ManagedDOMString

מאפיינים

  • פעילה

    מחרוזת אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    מחרוזת אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    מחרוזת אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. מוצג רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    מחרוזת אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    מחרוזת אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedDOMStringList

מאפיינים

  • פעילה

    string[] אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    string[] אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    string[] אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. השדה הזה מופיע רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    string[] אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    string[] אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedEthernetProperties

מאפיינים

ManagedIPConfigProperties

מאפיינים

ManagedIPConfigType

מאפיינים

  • פעילה

    IPConfigType אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    IPConfigType אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    IPConfigType אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. השדה הזה מופיע רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    IPConfigType אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    IPConfigType אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedLong

מאפיינים

  • פעילה

    מספר אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    מספר אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    מספר אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. השדה הזה מופיע רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    מספר אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    מספר אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedManualProxySettings

מאפיינים

ManagedProperties

מאפיינים

ManagedProxyLocation

ManagedProxySettings

מאפיינים

ManagedProxySettingsType

מאפיינים

  • פעילה

    ProxySettingsType אופציונלי

    הערך הפעיל שמשמש כרגע את מנהל הגדרות הרשת (למשל, Shill).

  • DeviceEditable

    בוליאני אופציונלי

    אם קיימת מדיניות DevicePolicy למאפיין והיא מאפשרת לערוך את המאפיין (כלומר, המדיניות מגדירה את ערך המאפיין המומלץ). ברירת המחדל היא false.

  • DevicePolicy

    ProxySettingsType אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המכשיר.

  • בתוקף

    מחרוזת אופציונלי

    המקור שממנו נקבע ערך המאפיין בפועל.

  • SharedSetting

    ProxySettingsType אופציונלי

    הערך שמוגדר לכל המשתמשים במכשיר. השדה הזה מופיע רק אם הערך של DeviceEditiable הוא true.

  • UserEditable

    בוליאני אופציונלי

    אם קיימת מדיניות משתמש (UserPolicy) לנכס והיא מאפשרת לערוך את הנכס (כלומר, המדיניות מגדירה את ערך הנכס המומלץ). ברירת המחדל היא false.

  • UserPolicy

    ProxySettingsType אופציונלי

    ערך המאפיין שסופק על ידי מדיניות המשתמש.

  • UserSetting

    ProxySettingsType אופציונלי

    ערך המאפיין שהוגדר על ידי המשתמש המחובר. השדה הזה מופיע רק אם הערך של UserEditable הוא true.

ManagedThirdPartyVPNProperties

מאפיינים

ManagedVPNProperties

מאפיינים

ManagedWiFiProperties

מאפיינים

ManualProxySettings

מאפיינים

  • FTPProxy

    ProxyLocation אופציונלי

    הגדרות לשרת proxy של FTP.

  • HTTPProxy

    ProxyLocation אופציונלי

    הגדרות ל-Proxy ל-HTTP.

  • SOCKS

    ProxyLocation אופציונלי

    הגדרות לשרת proxy מסוג SOCKS.

  • SecureHTTPProxy

    ProxyLocation אופציונלי

    הגדרות לשרת proxy מאובטח ל-HTTP.

NetworkConfigProperties

מאפיינים

NetworkFilter

מאפיינים

  • מוגדרת

    בוליאני אופציונלי

    אם הערך הוא true, הפלט כולל רק רשתות מוגדרות (שנשמרו). ברירת המחדל היא "false".

  • הגבלה

    מספר אופציונלי

    המספר המקסימלי של רשתות שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 1,000. כדי לא להגביל את המספר, צריך להזין 0.

  • networkType

    סוג הרשתות שיוחזרו.

  • גלוי

    בוליאני אופציונלי

    אם הערך הוא True, המערכת כוללת רק רשתות גלויות (מחוברות פיזית או בטווח). ברירת המחדל היא "false".

NetworkProperties

מאפיינים

  • רשת סלולרית

    CellularProperties אופציונלי

    לרשתות סלולריות, מאפייני רשת סלולרית.

  • ניתן לחיבור

    בוליאני אופציונלי

    אם אפשר להתחבר לרשת.

  • ConnectionState

    ConnectionStateType אופציונלי

    מצב החיבור הנוכחי של הרשת.

  • ErrorState

    מחרוזת אופציונלי

    מצב השגיאה האחרון שנרשם בחיבור לרשת.

  • אתרנט

    EthernetProperties אופציונלי

    לרשתות אתרנט, מאפייני רשת האתרנט.

  • GUID

    מחרוזת

    ‫GUID של הרשת.

  • IPAddressConfigType

    IPConfigType אופציונלי

    סוג ההגדרה של כתובת ה-IP של הרשת.

  • IPConfigs

    IPConfigProperties[] אופציונלי

    הגדרת ה-IP של הרשת.

  • MacAddress

    מחרוזת אופציונלי

    כתובת ה-MAC של הרשת.

  • נמדדת

    בוליאני אופציונלי

    ‫Chrome מגרסה 85 ואילך

    אם הרשת מבוססת על חיוב לפי שימוש בנתונים.

  • שם

    מחרוזת אופציונלי

    שם רשת ידידותי למשתמש.

  • NameServersConfigType

    IPConfigType אופציונלי

    סוג הגדרת ה-IP של שרתי השמות שבהם הרשת משתמשת.

  • עדיפות

    מספר אופציונלי

    עדיפות הרשת.

  • ProxySettings

    ProxySettings אופציונלי

    הגדרות שרת ה-proxy של הרשת.

  • RestrictedConnectivity

    בוליאני אופציונלי

    ברשת מחוברת, אם הקישוריות של הרשת לאינטרנט מוגבלת, למשל אם הרשת נמצאת מאחורי פורטל, או אם רשת סלולרית לא מופעלת.

  • SavedIPConfig

    IPConfigProperties אופציונלי

    הגדרת ה-IP שהתקבלה משרת ה-DHCP לפני החלת הגדרת ה-IP הסטטית.

  • מקור

    מחרוזת אופציונלי

    מציין אם הרשת מוגדרת ואיך. הערכים שאפשר לבחור הם:

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    הערך "None" מתנגש עם יצירת קוד התוסף, ולכן צריך להשתמש במחרוזת עבור "Source" במקום ב-enum של SourceType.

  • StaticIPConfig

    IPConfigProperties אופציונלי

    הגדרת ה-IP הסטטי של הרשת.

  • TrafficCounterResetTime

    מספר אופציונלי

    ‫Chrome מגרסה 125 ואילך

    מתי מוני התנועה אופסו לאחרונה.

  • סוג

    סוג הרשת.

  • VPN

    VPNProperties אופציונלי

    לרשתות VPN, מאפייני ה-VPN של הרשת.

  • Wi-Fi

    WiFiProperties אופציונלי

    לרשתות Wi-Fi, מאפייני ה-Wi-Fi של הרשת.

NetworkStateProperties

מאפיינים

NetworkType

טיפוסים בני מנייה (enum)

"הכול"

"רשת סלולרית"

"אתרנט"

"Tether"

"VPN"

"אלחוטי"

"WiFi"

PaymentPortal

מאפיינים

  • שיטה

    מחרוזת

    שיטת ה-HTTP שבה משתמשים בפורטל התשלומים.

  • PostData

    מחרוזת אופציונלי

    נתוני הפוסט שיישלחו לפורטל התשלומים. המערכת מתעלמת מהמדיניות הזו, אלא אם המדיניות Method מוגדרת כ-POST.

  • כתובת אתר

    מחרוזת אופציונלי

    כתובת ה-URL של פורטל התשלומים.

ProxyLocation

מאפיינים

  • מארח

    מחרוזת

    המארח של כתובת ה-IP של ה-Proxy.

  • יציאה

    number

    היציאה שבה צריך להשתמש בשביל שרת ה-proxy.

ProxySettings

מאפיינים

  • ExcludeDomains

    string[] אופציונלי

    דומיינים ומארחים שהגדרות לשרת proxy ידניות לא חלות עליהם.

  • ידני

    ManualProxySettings אופציונלי

    הגדרות ידניות לשרת proxy – משמשות רק להגדרות לשרת proxy של Manual.

  • קרן PAC

    מחרוזת אופציונלי

    כתובת ה-URL של קובץ התצורה האוטומטית של שרת ה-proxy.

  • סוג ההגדרות לשרת ה-proxy.

ProxySettingsType

טיפוסים בני מנייה (enum)

"Direct"

"ידני"

"PAC"

"WPAD"

SIMLockStatus

מאפיינים

  • LockEnabled

    בוליאני

    אם נעילת כרטיס ה-SIM מופעלת.

  • LockType

    מחרוזת

    הסטטוס של נעילת כרטיס ה-SIM – הערכים האפשריים הם 'sim-pin',‏ 'sim-puk' ו-''.

  • RetriesLeft

    מספר אופציונלי

    מספר הניסיונות המותרים לפתיחת נעילת קוד האימות לפני שנדרש קוד PUK כדי לבטל את נעילת ה-SIM.

ThirdPartyVPNProperties

מאפיינים

  • ExtensionID

    מחרוזת

    מזהה התוסף של ספק ה-VPN מצד שלישי.

  • ProviderName

    מחרוזת אופציונלי

    שם ספק ה-VPN.

VPNProperties

מאפיינים

  • AutoConnect

    בוליאני אופציונלי

    אם רשת ה-VPN צריכה להתחבר באופן אוטומטי.

  • מארח

    מחרוזת אופציונלי

    המארח של ה-VPN.

  • סוג

    מחרוזת אופציונלי

    סוג ה-VPN. הערך הזה לא יכול להיות enum בגלל "L2TP-IPSec". האפשרות הזו אופציונלית ל-NetworkConfigProperties, שמועבר ל-setProperties, שניתן להשתמש בו כדי להגדיר רק מאפיינים ספציפיים.

VPNStateProperties

מאפיינים

WiFiProperties

מאפיינים

  • AllowGatewayARPPolling

    בוליאני אופציונלי

    הוצא משימוש בגרסה Chrome 131

    הוסרה בגרסה M131. אין כרגע סקר ARP פעיל.

  • AutoConnect

    בוליאני אופציונלי

    אם צריך להתחבר לרשת ה-Wi-Fi באופן אוטומטי כשהיא בטווח.

  • BSSID

    מחרוזת אופציונלי

    מזהה ה-BSSID של נקודת הגישה המשויכת.

  • EAP

    ‫EAPProperties אופציונלי

    מאפייני ה-EAP של הרשת. חובה ברשתות WEP-8021X ו-WPA-EAP.

  • תדירות

    מספר אופציונלי

    תדר ההפעלה של שירות ה-Wi-Fi ב-MHz. ברשתות מחוברות, התדר הנוכחי שבו הרשת מחוברת. אחרת, התדירות של ה-BSS הכי טוב שזמין.

  • FrequencyList

    number[] אופציונלי

    מכיל את כל תדרי ההפעלה שנראו לאחרונה ברשת ה-Wi-Fi.

  • HexSSID

    מחרוזת אופציונלי

    עותק בקידוד HEX של ה-SSID של הרשת.

  • HiddenSSID

    בוליאני אופציונלי

    אם ה-SSID של הרשת ישודר.

  • ביטוי סיסמה

    מחרוזת אופציונלי

    Chrome 66 ואילך

    ביטוי הסיסמה לחיבורי WEP/WPA/WPA2. אפשר רק להגדיר את המאפיין הזה – מאפיינים שמוחזרים על ידי getProperties לא יכילו את הערך הזה.

  • RoamThreshold

    מספר אופציונלי

    הוצא משימוש, המערכת מתעלמת ממנו.

  • SSID

    מחרוזת אופציונלי

    ה-SSID של הרשת.

  • אבטחה

    מחרוזת אופציונלי

    סוג אבטחת הרשת.

  • SignalStrength

    מספר אופציונלי

    עוצמת האות של הרשת.

WiFiStateProperties

מאפיינים

WiMAXProperties

מאפיינים

  • AutoConnect

    בוליאני אופציונלי

    אם הרשת צריכה להתחבר באופן אוטומטי.

  • EAP

    ‫EAPProperties אופציונלי

    מאפייני ה-EAP של הרשת.

Methods

createNetwork()

Promise
chrome.networking.onc.createNetwork(
  shared: boolean,
  properties: NetworkConfigProperties,
  callback?: function,
)
: Promise<string>

יצירת הגדרת רשת חדשה ממאפיינים. אם כבר קיימת רשת תואמת שהוגדרה, הפעולה תיכשל. אחרת, הפונקציה מחזירה את ה-GUID של הרשת החדשה.

פרמטרים

  • משותפת

    בוליאני

    אם true, צריך לשתף את הגדרת הרשת הזו עם משתמשים אחרים.

    האפשרות הזו חשופה רק לממשק המשתמש של Chrome באינטרנט.* כשמתבצעת קריאה על ידי אפליקציות, false הוא הערך היחיד שמותר.

  • המאפיינים להגדרת הרשת החדשה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: string) => void

    • תוצאה

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

disableNetworkType()

chrome.networking.onc.disableNetworkType(
  networkType: NetworkType,
)
: void

השבתה של כל המכשירים שתואמים לסוג הרשת שצוין. ראו הערה לגבי enableNetworkType.

פרמטרים

  • networkType

    סוג הרשת שרוצים להשבית.

enableNetworkType()

chrome.networking.onc.enableNetworkType(
  networkType: NetworkType,
)
: void

האפשרות הזו מפעילה את כל המכשירים שתואמים לסוג הרשת שצוין. הערה: הסוג עשוי לייצג כמה סוגי רשתות (למשל, "אלחוטית").

פרמטרים

  • networkType

    סוג הרשת שרוצים להפעיל.

forgetNetwork()

Promise
chrome.networking.onc.forgetNetwork(
  networkGuid: string,
  callback?: function,
)
: Promise<void>

מחיקת הגדרת רשת מהזיכרון על ידי ניקוי כל המאפיינים שהוגדרו לרשת עם ה-GUID‏ networkGuid. ההגדרה הזו עשויה לכלול גם רשתות אחרות עם מזהים תואמים (למשל, SSID ואבטחה של Wi-Fi). אם אין הגדרה כזו, תופיע שגיאה והפעולה תיכשל.

בסשנים של מצב קיוסק, השיטה הזו לא תוכל למחוק הגדרות של רשתות משותפות.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים למחוק מהזיכרון.

  • callback

    function optional

    הפרמטר callback נראה כך:

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getCaptivePortalStatus()

Promise
chrome.networking.onc.getCaptivePortalStatus(
  networkGuid: string,
  callback?: function,
)
: Promise<CaptivePortalStatus>

הפונקציה מחזירה את סטטוס הפורטל השבוי של הרשת שתואמת ל-networkGuid.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים לקבל את סטטוס הפורטל השבוי שלה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: CaptivePortalStatus) => void

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getDeviceStates()

Promise
chrome.networking.onc.getDeviceStates(
  callback?: function,
)
: Promise<DeviceStateProperties[]>

מחזירה את המצבים של התקני הרשת הזמינים.

פרמטרים

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getGlobalPolicy()

Promise
chrome.networking.onc.getGlobalPolicy(
  callback?: function,
)
: Promise<GlobalPolicy>

הצגת מאפייני המדיניות הגלובלית. המאפיינים האלה לא צפויים להשתנות במהלך סשן.

פרמטרים

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: GlobalPolicy) => void

החזרות

  • Promise<GlobalPolicy>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getManagedProperties()

Promise
chrome.networking.onc.getManagedProperties(
  networkGuid: string,
  callback?: function,
)
: Promise<ManagedProperties>

מקבל את המאפיינים הממוזגים של הרשת עם המזהה networkGuid מהמקורות: הגדרות המשתמש, הגדרות משותפות, מדיניות המשתמש, מדיניות המכשיר וההגדרות הפעילות כרגע.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים לקבל את המאפיינים שלה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: ManagedProperties) => void

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getNetworks()

Promise
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
)
: Promise<NetworkStateProperties[]>

הפונקציה מחזירה רשימה של אובייקטים של רשת עם אותם מאפיינים שסופקו על ידי getState. יש מסנן שמאפשר לציין את סוג הרשתות שיוחזרו ולהגביל את מספר הרשתות. המערכת מסדרת את הרשתות לפי העדיפות שלהן, כשהרשתות המחוברות או המתחברות מופיעות קודם.

פרמטרים

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getProperties()

Promise
chrome.networking.onc.getProperties(
  networkGuid: string,
  callback?: function,
)
: Promise<NetworkProperties>

אחזור של כל המאפיינים של הרשת עם המזהה networkGuid. כולל את כל המאפיינים של הרשת (ערכים לקריאה בלבד וערכים לקריאה/כתיבה).

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים לקבל את המאפיינים שלה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: NetworkProperties) => void

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getState()

Promise
chrome.networking.onc.getState(
  networkGuid: string,
  callback?: function,
)
: Promise<NetworkStateProperties>

מקבל את המאפיינים השמורים במטמון לקריאה בלבד של הרשת עם המזהה networkGuid. הפונקציה הזו אמורה להיות בעלת ביצועים גבוהים יותר מאשר getProperties, שדורשת נסיעה הלוך ושוב כדי לשלוח שאילתה לתת-המערכת של הרשת. המאפיינים הבאים מוחזרים לכל הרשתות: GUID, ‏ Type, ‏ Name, ‏ WiFi.Security. לרשתות גלויות יש מאפיינים נוספים: ConnectionState, ‏ ErrorState, ‏ WiFi.SignalStrength, ‏ Cellular.NetworkTechnology, ‏ Cellular.ActivationState, ‏ Cellular.RoamingState.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים לקבל את המאפיינים שלה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    (result: NetworkStateProperties) => void

החזרות

  • ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

requestNetworkScan()

chrome.networking.onc.requestNetworkScan(
  networkType?: NetworkType,
)
: void

בקשות שתת-המערכת של הרשת תסרוק לאיתור רשתות חדשות ותעדכן את הרשימה שמוחזרת על ידי getVisibleNetworks. זו רק בקשה: תת-המערכת של הרשת יכולה להתעלם ממנה. אם הרשימה תתעדכן, האירוע onNetworkListChanged יופעל.

פרמטרים

  • networkType

    ‫NetworkType אופציונלי

    Chrome 63 ואילך

    אם צוין, נשלחת בקשה לסריקה ספציפית לסוג. בחיבור סלולרי, תתבצע בקשה לסריקה של רשת סלולרית, אם יש תמיכה בכך.

setProperties()

Promise
chrome.networking.onc.setProperties(
  networkGuid: string,
  properties: NetworkConfigProperties,
  callback?: function,
)
: Promise<void>

הגדרת המאפיינים של הרשת עם המזהה networkGuid. האפשרות הזו תקפה רק לרשתות שהוגדרו (מקור != ללא). במקום זאת, רשתות גלויות שלא הוגדרו צריכות להשתמש ב-createNetwork. בסשנים של קיוסק, קריאה ל-method הזו ברשת משותפת תיכשל.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים להגדיר לה מאפיינים.

  • המאפיינים שרוצים להגדיר.

  • callback

    function optional

    הפרמטר callback נראה כך:

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

startConnect()

Promise
chrome.networking.onc.startConnect(
  networkGuid: string,
  callback?: function,
)
: Promise<void>

הפעלת חיבור לרשת באמצעות networkGuid.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שאליה רוצים להתחבר.

  • callback

    function optional

    הפרמטר callback נראה כך:

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

startDisconnect()

Promise
chrome.networking.onc.startDisconnect(
  networkGuid: string,
  callback?: function,
)
: Promise<void>

התחלת ניתוק מהרשת באמצעות networkGuid.

פרמטרים

  • networkGuid

    מחרוזת

    ה-GUID של הרשת שרוצים להתנתק ממנה.

  • callback

    function optional

    הפרמטר callback נראה כך:

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 125 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

אירועים

onDeviceStateListChanged

chrome.networking.onc.onDeviceStateListChanged.addListener(
  callback: function,
)

מופעלת כשרשימת המכשירים משתנה או כשמאפייני המצב של מכשיר כלשהו משתנים.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך:

    () => void

onNetworkListChanged

chrome.networking.onc.onNetworkListChanged.addListener(
  callback: function,
)

מופעלת כשרשימת הרשתות משתנה. שליחת רשימה מלאה של מזהי GUID של כל הרשתות הנוכחיות.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך:

    (changes: string[]) => void

    • שינויים

      string[]‎

onNetworksChanged

chrome.networking.onc.onNetworksChanged.addListener(
  callback: function,
)

מופעל כשהמאפיינים משתנים באחת מהרשתות. שליחת רשימה של מזהים ייחודיים גלובליים (GUID) של רשתות שהמאפיינים שלהן השתנו.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך:

    (changes: string[]) => void

    • שינויים

      string[]‎

onPortalDetectionCompleted

chrome.networking.onc.onPortalDetectionCompleted.addListener(
  callback: function,
)

מופעל כשזיהוי הפורטל של רשת מסוימת מסתיים. שליחת ה-GUID של הרשת והסטטוס התואם של הפורטל השבוי.

פרמטרים