chrome.networking.onc

תיאור

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

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

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

הרשאות

networking.onc

זמינות

Chrome מגרסה 59 ואילך ב-ChromeOS בלבד

סוגים

ActivationStateType

Enum

'הופעל'

'הפעלה'

'NotActivated'

"PartiallyActivated"

CaptivePortalStatus

Enum

'לא ידוע'

'אופליין'

'Online'

'פורטל'

"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 (Mobile Country Code) וקוד ה-MNC (Mobile Network Code) של הרשת.

  • מדינה

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

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

  • שם

    מחרוזת

    שם המפעיל.

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

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

    Chrome מגרסה 62 ואילך

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

  • סריקה

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

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

  • מדינה

    DeviceStateType

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

  • סוג

    NetworkType

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

DeviceStateType

Enum

'לא הוגדר'
המכשיר זמין אבל לא הוגדר.

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

'הפעלה'
הבקשה להפעלה נשלחה אבל לא הושלמה.

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

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

EAPProperties

מאפיינים

  • AnonymousIdentity

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

  • ClientCertPKCS11Id

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

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

    CertificatePattern אופציונלי

  • ClientCertProvisioningProfileId

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

    גרסה 93 ואילך של Chrome
  • ClientCertRef

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

  • ClientCertType

    ClientCertificateType

  • זהויות

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

  • פנימי

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

  • חיצוני

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

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

  • סיסמה

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

  • SaveCredentials

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

  • ServerCAPEMs

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

  • ServerCARefs

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

  • SubjectMatch

    ManagedDOMString אופציונלי

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

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

  • UseSystemCAs

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

EthernetProperties

מאפיינים

  • אימות

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

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

  • AutoConnect

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

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

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

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

  • סוג

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

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

  • WebProxyAutoDiscoveryUrl

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

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

IPConfigType

Enum

"DHCP"

'Static'

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'.

  • הגבלה

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

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

  • networkType

    NetworkType

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

  • גלוי

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

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

NetworkProperties

מאפיינים

  • רשת סלולרית

    CellularProperties אופציונלי

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

  • ניתן להתחבר

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

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

  • ConnectionState

    ConnectionStateType אופציונלי

    סטטוס החיבור הנוכחי של הרשת.

  • ErrorState

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

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

  • אתרנט

    EthernetProperties אופציונלי

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

  • 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

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

    גרסה 125 ואילך של Chrome

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

  • סוג

    NetworkType

    סוג הרשת.

  • VPN

    VPNProperties אופציונלי

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

  • Wi-Fi

    WiFiProperties אופציונלי

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

NetworkStateProperties

מאפיינים

NetworkType

Enum

'הכול'

'Cellular'

"Ethernet"

'קישור'

"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

'ישיר'

'ידני'

"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

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

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

  • 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,
)

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

פרמטרים

  • משותף

    בוליאני

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

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

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

  • קריאה חוזרת (callback)

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

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

    (result: string) => void

    • תוצאה

      מחרוזת

החזרות

  • Promise<string>

    גרסה 125 ואילך של Chrome

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

disableNetworkType()

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

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

פרמטרים

  • networkType

    NetworkType

    סוג הרשת להשבתה.

enableNetworkType()

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

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

פרמטרים

  • networkType

    NetworkType

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

forgetNetwork()

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

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • Promise<void>

    גרסה 125 ואילך של Chrome

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getCaptivePortalStatus()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • קריאה חוזרת (callback)

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

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

    (result: CaptivePortalStatus) => void

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getDeviceStates()

Promise 
chrome.networking.onc.getDeviceStates(
  callback?: function,
)

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

פרמטרים

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getGlobalPolicy()

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

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

פרמטרים

  • קריאה חוזרת (callback)

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

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

    (result: GlobalPolicy) => void

החזרות

  • Promise<GlobalPolicy>

    גרסה 125 ואילך של Chrome

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getManagedProperties()

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

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

פרמטרים

  • networkGuid

    מחרוזת

    מזהה ה-GUID של הרשת שעבורה רוצים לקבל נכסים.

  • קריאה חוזרת (callback)

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

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

    (result: ManagedProperties) => void

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getNetworks()

Promise 
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
)

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

פרמטרים

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getProperties()

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

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

פרמטרים

  • networkGuid

    מחרוזת

    מזהה ה-GUID של הרשת שעבורה רוצים לקבל נכסים.

  • קריאה חוזרת (callback)

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

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

    (result: NetworkProperties) => void

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getState()

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

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

פרמטרים

  • networkGuid

    מחרוזת

    מזהה ה-GUID של הרשת שעבורה רוצים לקבל נכסים.

  • קריאה חוזרת (callback)

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

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

    (result: NetworkStateProperties) => void

החזרות

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

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

requestNetworkScan()

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

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

פרמטרים

  • networkType

    NetworkType אופציונלי

    Chrome מגרסה 63 ואילך

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

setProperties()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

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

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • Promise<void>

    גרסה 125 ואילך של Chrome

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

startConnect()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • Promise<void>

    גרסה 125 ואילך של Chrome

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

startDisconnect()

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

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

פרמטרים

  • networkGuid

    מחרוזת

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

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • Promise<void>

    גרסה 125 ואילך של Chrome

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

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    (networkGuid: string, status: CaptivePortalStatus) => void