chrome.networking.onc

תיאור

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

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

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

הרשאות

networking.onc

זמינות

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

סוגים

ActivationStateType

Enum

'הופעל'

'הפעלה'

‎"NotActivated"

"PartiallyActivated"

CaptivePortalStatus

Enum

‫Unknown

Offline

'אונליין'

‫Portal

‫"ProxyAuthRequired"

CellularProperties

מאפיינים

  • ActivationState

    ‫ActivationStateType optional

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

  • ActivationType

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

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

  • AllowRoaming

    ‫boolean אופציונלי

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

  • AutoConnect

    ‫boolean אופציונלי

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

  • משפחתי

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

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

  • FirmwareRevision

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

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

  • FoundNetworks

    FoundNetworkProperties[] optional

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

  • HardwareRevision

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

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

  • HomeProvider

    ‫CellularProviderProperties אופציונלי

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

  • היצרן

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

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

  • ModelID

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

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

  • NetworkTechnology

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

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

  • PaymentPortal

    ‫PaymentPortal אופציונלי

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

  • RoamingState

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

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

  • SIMLockStatus

    ‫SIMLockStatus אופציונלי

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

  • SIMPresent

    ‫boolean אופציונלי

    אם יש כרטיס SIM.

  • סריקה

    ‫boolean אופציונלי

    ‫Chrome 63 ואילך

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

  • ServingOperator

    ‫CellularProviderProperties אופציונלי

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

  • SignalStrength

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

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

  • SupportNetworkScan

    ‫boolean אופציונלי

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

CellularProviderProperties

מאפיינים

  • קוד

    מחרוזת

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

  • מדינה

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

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

  • שם

    מחרוזת

    שם האופרטור.

CellularStateProperties

מאפיינים

CertificatePattern

מאפיינים

  • EnrollmentURI

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

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

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

    ‫IssuerSubjectPattern אופציונלי

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

  • IssuerCARef

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

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

  • נושא

    ‫IssuerSubjectPattern אופציונלי

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

ClientCertificateType

Enum

‫"Ref"

‫"Pattern"

ConnectionStateType

Enum

'מחובר'

'מתחבר'

‫"NotConnected"

DeviceStateProperties

מאפיינים

  • SIMLockStatus

    ‫SIMLockStatus אופציונלי

    ‫Chrome 62 ואילך

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

  • SIMPresent

    ‫boolean אופציונלי

    ‫Chrome 62 ואילך

    אם סוג המכשיר הוא סלולרי, המצב מוגדר ל'כרטיס SIM קיים'.

  • סריקה

    ‫boolean אופציונלי

    הגדרה אם המכשיר מופעל. הערך הוא True אם המכשיר סורק כרגע.

  • מדינה

    DeviceStateType

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

  • סוג

    NetworkType

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

DeviceStateType

Enum

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

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

'הפעלה'
התקבלה בקשה להפעלה, אבל היא לא הושלמה.

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

Prohibited
Device is prohibited.

EAPProperties

מאפיינים

  • AnonymousIdentity

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

  • ClientCertPKCS11Id

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

    ‫Chrome 60 ואילך
  • ClientCertPattern

    ‫CertificatePattern אופציונלי

  • ClientCertProvisioningProfileId

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

    ‫Chrome 93 ואילך
  • ClientCertRef

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

  • ClientCertType

    ClientCertificateType

  • זהויות

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

  • פנימי

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

  • Outer

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

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

  • סיסמה

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

  • SaveCredentials

    ‫boolean אופציונלי

  • ServerCAPEMs

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

  • ServerCARefs

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

  • SubjectMatch

    ‫ManagedDOMString אופציונלי

    ‫Chrome 60 ואילך
  • UseProactiveKeyCaching

    ‫boolean אופציונלי

  • UseSystemCAs

    ‫boolean אופציונלי

EthernetProperties

מאפיינים

  • אימות

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

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

  • AutoConnect

    ‫boolean אופציונלי

    האם להתחבר אוטומטית לרשת אתרנט.

  • EAP

    ‫EAPProperties אופציונלי

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

EthernetStateProperties

מאפיינים

FoundNetworkProperties

מאפיינים

  • LongName

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

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

  • NetworkId

    מחרוזת

    מזהה הרשת.

  • ShortName

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

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

  • סטטוס

    מחרוזת

    זמינות הרשת.

  • טכנולוגיה

    מחרוזת

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

GlobalPolicy

מאפיינים

  • AllowOnlyPolicyNetworksToAutoconnect

    ‫boolean אופציונלי

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

  • AllowOnlyPolicyNetworksToConnect

    ‫boolean אופציונלי

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

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    ‫boolean אופציונלי

    ‫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 ואילך

    מערך של מחרוזות לפתרון שמות, פרטים נוספים זמינים בקובץ onc_spec.md.

  • סוג

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

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

  • WebProxyAutoDiscoveryUrl

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

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

IPConfigType

Enum

‫"DHCP"

‫"Static"

IssuerSubjectPattern

מאפיינים

  • CommonName

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

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

  • ישוב

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

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

  • ארגון

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

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

  • OrganizationalUnit

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

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

ManagedBoolean

מאפיינים

  • פעיל

    ‫boolean אופציונלי

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

    ‫boolean אופציונלי

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

  • בתוקף

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

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

  • SharedSetting

    ‫boolean אופציונלי

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

    ‫boolean אופציונלי

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

  • UserSetting

    ‫boolean אופציונלי

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

ManagedCellularProperties

מאפיינים

ManagedDOMString

מאפיינים

  • פעיל

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

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

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

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

  • בתוקף

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

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

  • SharedSetting

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

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

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

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

  • UserSetting

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

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

ManagedDOMStringList

מאפיינים

  • פעיל

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

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

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

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

  • בתוקף

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

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

  • SharedSetting

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

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

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

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

  • UserSetting

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

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

ManagedEthernetProperties

מאפיינים

ManagedIPConfigProperties

מאפיינים

ManagedIPConfigType

מאפיינים

  • פעיל

    ‫IPConfigType optional

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

    ‫IPConfigType optional

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

  • בתוקף

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

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

  • SharedSetting

    ‫IPConfigType optional

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

    ‫IPConfigType optional

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

  • UserSetting

    ‫IPConfigType optional

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

ManagedLong

מאפיינים

  • פעיל

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

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

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

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

  • בתוקף

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

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

  • SharedSetting

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

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

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

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

  • UserSetting

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

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

ManagedManualProxySettings

מאפיינים

ManagedProperties

מאפיינים

ManagedProxyLocation

מאפיינים

ManagedProxySettings

מאפיינים

ManagedProxySettingsType

מאפיינים

  • פעיל

    ‫ProxySettingsType אופציונלי

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

  • DeviceEditable

    ‫boolean אופציונלי

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

  • DevicePolicy

    ‫ProxySettingsType אופציונלי

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

  • בתוקף

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

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

  • SharedSetting

    ‫ProxySettingsType אופציונלי

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

  • UserEditable

    ‫boolean אופציונלי

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

  • UserPolicy

    ‫ProxySettingsType אופציונלי

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

  • UserSetting

    ‫ProxySettingsType אופציונלי

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

ManagedThirdPartyVPNProperties

מאפיינים

ManagedVPNProperties

מאפיינים

ManagedWiFiProperties

מאפיינים

ManualProxySettings

מאפיינים

  • FTPProxy

    ‫ProxyLocation אופציונלי

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

  • HTTPProxy

    ‫ProxyLocation אופציונלי

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

  • SOCKS

    ‫ProxyLocation אופציונלי

    הגדרות ל-SOCKS proxy.

  • SecureHTTPProxy

    ‫ProxyLocation אופציונלי

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

NetworkConfigProperties

מאפיינים

NetworkFilter

מאפיינים

  • מוגדר

    ‫boolean אופציונלי

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

  • הגבלה

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

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

  • networkType

    NetworkType

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

  • גלוי

    ‫boolean אופציונלי

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

NetworkProperties

מאפיינים

  • רשת סלולרית

    ‫CellularProperties אופציונלי

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

  • ניתן לחיבור

    ‫boolean אופציונלי

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

  • ConnectionState

    ‫ConnectionStateType אופציונלי

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

  • ErrorState

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

    המצב האחרון של שגיאת הרשת שתועדה.

  • אתרנט

    ‫EthernetProperties אופציונלי

    ברשתות Ethernet, המאפיינים של רשת ה-Ethernet.

  • GUID

    מחרוזת

    ‫GUID של הרשת.

  • IPAddressConfigType

    ‫IPConfigType optional

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

  • IPConfigs

    ‫IPConfigProperties[] optional

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

  • MacAddress

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

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

  • נמדדת

    ‫boolean אופציונלי

    ‫Chrome 85 ואילך

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

  • שם

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

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

  • NameServersConfigType

    ‫IPConfigType optional

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

  • עדיפות

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

    העדיפות של הרשת.

  • ProxySettings

    ‫ProxySettings אופציונלי

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

  • RestrictedConnectivity

    ‫boolean אופציונלי

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

  • SavedIPConfig

    ‫IPConfigProperties אופציונלי

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

  • מקור

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

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

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

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

  • StaticIPConfig

    ‫IPConfigProperties אופציונלי

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

  • TrafficCounterResetTime

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

    ‫Chrome 125 ואילך

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

  • סוג

    NetworkType

    סוג הרשת.

  • VPN

    ‫VPNProperties אופציונלי

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

  • Wi-Fi

    ‫WiFiProperties אופציונלי

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

NetworkStateProperties

מאפיינים

NetworkType

Enum

‫"All"

"סלולר"

‫"Ethernet"

‫"Tether"

‫"VPN"

'אלחוטי'

‫"WiFi"

PaymentPortal

מאפיינים

  • שיטה

    מחרוזת

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

  • PostData

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

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

  • כתובת אתר

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

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

ProxyLocation

מאפיינים

  • מארח

    מחרוזת

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

  • יציאה

    number

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

ProxySettings

מאפיינים

  • ExcludeDomains

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

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

  • ידני

    ‫ManualProxySettings אופציונלי

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

  • קרן PAC

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

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

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

ProxySettingsType

Enum

"ישיר"

"ידני"

"PAC"

‫"WPAD"

SIMLockStatus

מאפיינים

  • LockEnabled

    בוליאני

    האם נעילת ה-SIM מופעלת.

  • LockType

    מחרוזת

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

  • RetriesLeft

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

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

ThirdPartyVPNProperties

מאפיינים

  • ExtensionID

    מחרוזת

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

  • ProviderName

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

    השם של ספק ה-VPN.

VPNProperties

מאפיינים

  • AutoConnect

    ‫boolean אופציונלי

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

  • מארח

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

    מארח ה-VPN.

  • סוג

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

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

VPNStateProperties

מאפיינים

WiFiProperties

מאפיינים

  • AllowGatewayARPPolling

    ‫boolean אופציונלי

    הוצא משימוש מאז Chrome 131

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

  • AutoConnect

    ‫boolean אופציונלי

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

  • BSSID

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

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

  • EAP

    ‫EAPProperties אופציונלי

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

  • תדירות

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

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

  • FrequencyList

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

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

  • HexSSID

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

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

  • HiddenSSID

    ‫boolean אופציונלי

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

  • ביטוי סיסמה

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

    ‫Chrome 66 ואילך

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

  • RoamThreshold

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

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

  • SSID

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

    ה-SSID של הרשת.

  • אבטחה

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

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

  • SignalStrength

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

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

WiFiStateProperties

מאפיינים

WiMAXProperties

מאפיינים

  • AutoConnect

    ‫boolean אופציונלי

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

  • EAP

    ‫EAPProperties אופציונלי

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

Methods

createNetwork()

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

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

פרמטרים

  • משותפת

    בוליאני

    אם true, משתפים את תצורת הרשת הזו עם משתמשים אחרים.

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

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

  • callback

    פונקציה אופציונלית

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

    (result: string) => void

    • תוצאה

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

disableNetworkType()

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

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

פרמטרים

  • networkType

    NetworkType

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

enableNetworkType()

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

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

פרמטרים

  • networkType

    NetworkType

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

forgetNetwork()

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

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getCaptivePortalStatus()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    (result: CaptivePortalStatus) => void

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getDeviceStates()

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

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

פרמטרים

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getGlobalPolicy()

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

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

פרמטרים

  • callback

    פונקציה אופציונלית

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

    (result: GlobalPolicy) => void

החזרות

  • Promise<GlobalPolicy>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getManagedProperties()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    (result: ManagedProperties) => void

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getNetworks()

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

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

פרמטרים

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getProperties()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    (result: NetworkProperties) => void

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

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

    פונקציה אופציונלית

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

    (result: NetworkStateProperties) => void

החזרות

  • ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

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. ההגדרה הזו תקפה רק לרשתות מוגדרות (מקור != None). ברשתות גלויות שלא הוגדרו צריך להשתמש ב-createNetwork במקום זאת. בסשנים של קיוסק, קריאה לשיטה הזו ברשת משותפת תיכשל.

פרמטרים

  • networkGuid

    מחרוזת

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

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

startConnect()

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

מתחיל חיבור לרשת עם networkGuid.

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

startDisconnect()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • callback

    פונקציה אופציונלית

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 125 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

אירועים

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 של הרשת ואת הסטטוס של הפורטל השבוי שמתאים לו.

פרמטרים