chrome.networking.onc

Descrição

A API chrome.networking.onc é usada para configurar conexões de rede (celular, Ethernet, VPN ou Wi-Fi). Essa API está disponível em sessões de quiosque do Chrome OS iniciadas automaticamente.

As configurações de conexão de rede são especificadas de acordo com a especificação Open Network Configuration (ONC).

OBSERVAÇÃO: a maioria das propriedades de dicionário e valores de enumeração usam UpperCamelCase para corresponder à especificação ONC, em vez da convenção de lowerCamelCase do JavaScript.

Permissões

networking.onc

Disponibilidade

Chrome 59 e versões mais recentes Somente no ChromeOS

Tipos

ActivationStateType

Enumeração

"Ativado"

"Ativação"

"NotActivated"

"PartiallyActivated"

CaptivePortalStatus

Enumeração

"Unknown"

"Off-line"

"Online"

"Portal"

"ProxyAuthRequired"

CellularProperties

Propriedades

  • ActivationState

    ActivationStateType opcional

    Estado de ativação da conta da operadora.

  • ActivationType

    string opcional

    O tipo de ativação da rede celular.

  • AllowRoaming

    booleano opcional

    Se o roaming é permitido para a rede.

  • AutoConnect

    booleano opcional

    Se a rede celular precisa ser conectada automaticamente (quando estiver no alcance).

  • Família

    string opcional

    Família de tecnologia de dispositivo celular: CDMA ou GSM.

  • FirmwareRevision

    string opcional

    A revisão do firmware carregada no modem celular.

  • FoundNetworks

    FoundNetworkProperties[] opcional

    A lista de redes encontradas durante a verificação de rede mais recente.

  • HardwareRevision

    string opcional

    A revisão de hardware do modem celular.

  • HomeProvider

    CellularProviderProperties opcional

    Informações sobre a operadora que emitiu o chip instalado no modem.

  • Fabricante

    string opcional

    O fabricante do modem celular.

  • ModelID

    string opcional

    O ID do modelo do modem celular.

  • NetworkTechnology

    string opcional

    Se o modem estiver registrado em uma rede, a tecnologia de rede atualmente em uso.

  • PaymentPortal

    PaymentPortal opcional

    Portal de pagamento on-line que um usuário pode usar para se inscrever ou modificar um plano de dados móveis.

  • RoamingState

    string opcional

    O estado de roaming do modem celular na rede atual.

  • SIMLockStatus

    SIMLockStatus opcional

    O estado do bloqueio do chip para redes da família GSM.

  • SIMPresent

    booleano opcional

    Se um chip está presente.

  • Verificação

    booleano opcional

    Chrome 63 ou mais recente

    "True" quando uma verificação de rede celular está em andamento.

  • ServingOperator

    CellularProviderProperties opcional

    Informações sobre a operadora em cuja rede o modem está registrado no momento.

  • SignalStrength

    número opcional

    A intensidade atual do sinal da rede.

  • SupportNetworkScan

    booleano opcional

    Se a rede celular oferece suporte à verificação.

CellularProviderProperties

Propriedades

  • Código

    string

    O ID da rede celular como uma concatenação simples do MCC (código de país para dispositivos móveis) e do MNC (código de rede móvel) da rede.

  • País

    string opcional

    O código de país com duas letras.

  • Nome

    string

    O nome do operador.

CellularStateProperties

Propriedades

CertificatePattern

Propriedades

  • EnrollmentURI

    string[] opcional

    Lista de URIs para os quais o usuário pode ser direcionado caso nenhum certificado correspondente a esse padrão seja encontrado.

  • Emissor

    IssuerSubjectPattern opcional

    Se definido, o padrão em que as configurações do emissor X.509 precisam ser correspondidas.

  • IssuerCARef

    string[] opcional

    Lista de certificados de AC de emissor de certificados. Um certificado precisa ser assinado por um deles para corresponder a esse padrão.

  • Assunto

    IssuerSubjectPattern opcional

    Se definido, o padrão em que as configurações do assunto X.509 precisam ser correspondidas.

ClientCertificateType

Enumeração

"Ref"

"Padrão"

ConnectionStateType

Enumeração

"Conectado"

"Conectando"

"NotConnected"

DeviceStateProperties

Propriedades

  • SIMLockStatus

    SIMLockStatus opcional

    Chrome 62 ou mais recente

    O status de bloqueio do chip se Type = Cellular e SIMPresent = True.

  • SIMPresent

    booleano opcional

    Chrome 62 ou mais recente

    Defina o estado do SIM como presente se o tipo de dispositivo for celular.

  • Verificação

    booleano opcional

    Define se o dispositivo está ativado. Verdadeiro se o dispositivo estiver fazendo a varredura.

  • O estado atual do dispositivo.

  • O tipo de rede associado ao dispositivo (celular, Ethernet ou Wi-Fi).

DeviceStateType

Enumeração

"Uninitialized"
O dispositivo está disponível, mas não foi inicializado.

"Desativado"
O dispositivo está inicializado, mas não ativado.

"Ativação"
O estado "Ativado" foi solicitado, mas não foi concluído.

"Ativado"
O dispositivo está ativado.

"Proibido"
O dispositivo está proibido.

EAPProperties

Propriedades

  • AnonymousIdentity

    string opcional

  • ClientCertPKCS11Id

    string opcional

    Chrome 60+
  • ClientCertPattern

    CertificatePattern opcional

  • ClientCertProvisioningProfileId

    string opcional

    Chrome 93 e versões mais recentes
  • ClientCertRef

    string opcional

  • ClientCertType

    ClientCertificateType

  • Identidade

    string opcional

  • INTERNO

    string opcional

  • EXTERNO

    string opcional

    O tipo de EAP externo. Obrigatório pelo ONC, mas pode não ser fornecido ao traduzir do Shill.

  • Senha

    string opcional

  • SaveCredentials

    booleano opcional

  • ServerCAPEMs

    string[] opcional

  • ServerCARefs

    string[] opcional

  • SubjectMatch

    ManagedDOMString opcional

    Chrome 60+
  • UseProactiveKeyCaching

    booleano opcional

  • UseSystemCAs

    booleano opcional

EthernetProperties

Propriedades

  • Autenticação

    string opcional

    A autenticação usada pela rede Ethernet. Os valores possíveis são None e 8021X.

  • AutoConnect

    booleano opcional

    Indica se a rede Ethernet precisa ser conectada automaticamente.

  • EAP

    EAPProperties opcional

    Configurações de EAP da rede. Necessário para autenticação 8021X.

EthernetStateProperties

Propriedades

FoundNetworkProperties

Propriedades

  • LongName

    string opcional

    O nome do operador de rede no formato longo.

  • NetworkId

    string

    ID da rede.

  • ShortName

    string opcional

    O nome abreviado do operador de rede.

  • Status

    string

    Disponibilidade de rede.

  • Tecnologia

    string

    Tecnologia de acesso usada pela rede.

GlobalPolicy

Propriedades

  • AllowOnlyPolicyNetworksToAutoconnect

    booleano opcional

    Se verdadeiro, somente as redes de políticas poderão se conectar automaticamente. O padrão é "false".

  • AllowOnlyPolicyNetworksToConnect

    booleano opcional

    Se for verdadeiro, apenas as redes de políticas poderão ser conectadas, e nenhuma nova rede poderá ser adicionada ou configurada. O padrão é "false".

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    booleano opcional

    Chrome 70 ou mais recente

    Se for verdadeiro e uma rede gerenciada estiver disponível na lista de redes visíveis, apenas as redes de políticas poderão ser conectadas, e nenhuma nova rede poderá ser adicionada ou configurada. O padrão é "false".

  • BlockedHexSSIDs

    string[] opcional

    Chrome 86 e versões mais recentes

    Lista de redes bloqueadas. As conexões com redes bloqueadas são proibidas. É possível desbloquear as redes novamente especificando uma configuração explícita. O padrão é uma lista vazia.

IPConfigProperties

Propriedades

  • ExcludedRoutes

    string[] opcional

    Chrome 76 e versões mais recentes

    Matriz de blocos de IP na notação CIDR. Consulte onc_spec.md para mais detalhes.

  • Gateway

    string opcional

    Endereço de gateway usado para a configuração de IP.

  • IPAddress

    string opcional

    O endereço IP de uma conexão. Pode ser um endereço IPv4 ou IPv6, dependendo do valor de Type.

  • IncludedRoutes

    string[] opcional

    Chrome 76 e versões mais recentes

    Matriz de blocos de IP na notação CIDR. Consulte onc_spec.md para mais detalhes.

  • NameServers

    string[] opcional

    Matriz de endereços usados para servidores de nomes.

  • RoutingPrefix

    número opcional

    O prefixo de roteamento.

  • SearchDomains

    string[] opcional

    Chrome 76 e versões mais recentes

    Matriz de strings para resolução de nomes. Consulte onc_spec.md para mais detalhes.

  • Tipo

    string opcional

    O tipo de configuração de IP. Pode ser IPv4 ou IPv6.

  • WebProxyAutoDiscoveryUrl

    string opcional

    O URL da descoberta automática do proxy da Web, conforme informado pelo DHCP.

IPConfigType

Enumeração

"DHCP"

"Estático"

IssuerSubjectPattern

Propriedades

  • CommonName

    string opcional

    Se definido, o valor em que o nome comum do assunto do certificado precisa ser comparado.

  • Localidade

    string opcional

    Se definido, o valor a ser comparado com o local comum do assunto do certificado.

  • Organização

    string opcional

    Se definido, o valor em que as organizações do assunto do certificado precisam ser correspondentes. Pelo menos uma organização precisa corresponder ao valor.

  • OrganizationalUnit

    string opcional

    Se definido, o valor a ser comparado com as unidades organizacionais do assunto do certificado. Pelo menos uma unidade organizacional precisa corresponder ao valor.

ManagedBoolean

Propriedades

  • Ativo

    booleano opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    booleano opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    booleano opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    booleano opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    booleano opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedCellularProperties

Propriedades

ManagedDOMString

Propriedades

  • Ativo

    string opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    string opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    string opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    string opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    string opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedDOMStringList

Propriedades

  • Ativo

    string[] opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    string[] opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    string[] opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    string[] opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    string[] opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedEthernetProperties

Propriedades

ManagedIPConfigProperties

Propriedades

ManagedIPConfigType

Propriedades

  • Ativo

    IPConfigType opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    IPConfigType opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    IPConfigType opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    IPConfigType opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    IPConfigType opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedLong

Propriedades

  • Ativo

    número opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    número opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    número opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    número opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    número opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedManualProxySettings

Propriedades

ManagedProperties

Propriedades

ManagedProxyLocation

Propriedades

ManagedProxySettings

Propriedades

ManagedProxySettingsType

Propriedades

  • Ativo

    ProxySettingsType opcional

    O valor ativo usado atualmente pelo gerenciador de configuração de rede (por exemplo, Shill).

  • DeviceEditable

    booleano opcional

    Indica se uma DevicePolicy para a propriedade existe e permite que ela seja editada (ou seja, se a política define o valor recomendado da propriedade). O valor padrão é false.

  • DevicePolicy

    ProxySettingsType opcional

    O valor da propriedade fornecido pela política do dispositivo.

  • Efetivo

    string opcional

    A origem em que o valor da propriedade efetiva foi determinado.

  • SharedSetting

    ProxySettingsType opcional

    O valor definido para todos os usuários do dispositivo. Só é fornecido se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se uma UserPolicy para a propriedade existe e permite que ela seja editada (ou seja, o valor da propriedade recomendada pela política). O valor padrão é false.

  • UserPolicy

    ProxySettingsType opcional

    O valor da propriedade fornecido pela política do usuário.

  • UserSetting

    ProxySettingsType opcional

    O valor da propriedade definido pelo usuário conectado. Só é fornecido se UserEditable for true.

ManagedThirdPartyVPNProperties

Propriedades

ManagedVPNProperties

Propriedades

ManagedWiFiProperties

Propriedades

ManualProxySettings

Propriedades

  • FTPProxy

    ProxyLocation opcional

    Configurações do proxy FTP.

  • HTTPProxy

    ProxyLocation opcional

    Configurações do proxy HTTP.

  • MEIAS

    ProxyLocation opcional

    Configurações para proxy SOCKS.

  • SecureHTTPProxy

    ProxyLocation opcional

    Configurações para proxy HTTP seguro.

NetworkConfigProperties

Propriedades

NetworkFilter

Propriedades

  • configurado

    booleano opcional

    Se verdadeiro, inclui apenas as redes configuradas (salvas). O padrão é "false".

  • limite

    número opcional

    Número máximo de redes a serem retornadas. O padrão é 1.000 se não for especificado. Use 0 para não ter limite.

  • networkType

    NetworkType

    O tipo de redes a ser retornado.

  • visível

    booleano opcional

    Se verdadeiro, inclui apenas redes visíveis (conectadas fisicamente ou no alcance). O padrão é "false".

NetworkProperties

Propriedades

  • Rede celular

    CellularProperties opcional

    Para redes celulares, propriedades de rede celular.

  • Conectável

    booleano opcional

    Indica se a rede pode ser conectada.

  • ConnectionState

    ConnectionStateType opcional

    O estado atual da conexão da rede.

  • ErrorState

    string opcional

    O último estado de erro de rede registrado.

  • Ethernet

    EthernetProperties opcional

    Para redes Ethernet, as propriedades da rede Ethernet.

  • GUID

    string

    O GUID da rede.

  • IPAddressConfigType

    IPConfigType opcional

    O tipo de configuração do endereço IP da rede.

  • IPConfigs

    IPConfigProperties[] opcional

    A configuração de IP da rede.

  • MacAddress

    string opcional

    O endereço MAC da rede.

  • Limitada

    booleano opcional

    Chrome 85 e versões mais recentes

    Se a rede é tarifada.

  • Nome

    string opcional

    Um nome de rede fácil de usar.

  • NameServersConfigType

    IPConfigType opcional

    O tipo de configuração de IP dos servidores de nomes usados pela rede.

  • Prioridade

    número opcional

    A prioridade da rede.

  • ProxySettings

    ProxySettings opcional

    As configurações de proxy da rede.

  • RestrictedConnectivity

    booleano opcional

    Para uma rede conectada, se a conectividade da rede à Internet é limitada, por exemplo, se a rede está por trás de um portal ou se uma rede celular não está ativada.

  • SavedIPConfig

    IPConfigProperties opcional

    Configuração de IP recebida do servidor DHCP antes da aplicação da configuração de IP estático.

  • Origem

    string opcional

    Indica se e como a rede está configurada. Os valores possíveis são:

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    "None" entra em conflito com a geração de código da extensão. Portanto, é necessário usar uma string para "Source" em vez de um tipo enumerado SourceType.

  • StaticIPConfig

    IPConfigProperties opcional

    A configuração de IP estático da rede.

  • TrafficCounterResetTime

    número opcional

    Chrome 125+

    Quando os contadores de tráfego foram redefinidos pela última vez.

  • O tipo de rede.

  • VPN

    VPNProperties opcional

    Para redes VPN, as propriedades de VPN da rede.

  • Wi-Fi

    WiFiProperties opcional

    Para redes Wi-Fi, as propriedades de rede Wi-Fi.

NetworkStateProperties

Propriedades

NetworkType

Enumeração

"Todos"

"Celular"

"Ethernet"

"Tether"

"VPN"

"Sem fio"

"WiFi"

PaymentPortal

Propriedades

  • Método

    string

    O método HTTP a ser usado para o portal de pagamento.

  • PostData

    string opcional

    Os dados de postagem a serem enviados ao portal de pagamento. Ignorado a menos que Method seja POST.

  • URL

    string opcional

    O URL do portal de pagamento.

ProxyLocation

Propriedades

  • Host

    string

    O host do endereço IP do proxy.

  • Porta

    number

    A porta a ser usada para o proxy.

ProxySettings

Propriedades

  • ExcludeDomains

    string[] opcional

    Domínios e hosts para os quais as configurações manuais de proxy são excluídas.

  • Manual

    ManualProxySettings opcional

    Configurações manuais de proxy: usadas apenas para configurações de proxy Manual.

  • PAC (Comitê de Ação Política)

    string opcional

    URL do arquivo de autoconfiguração do proxy.

  • O tipo de configurações de proxy.

ProxySettingsType

Enumeração

"Direct"

"Manual"

"PAC"

"WPAD"

SIMLockStatus

Propriedades

  • LockEnabled

    booleano

    Se o bloqueio do chip está ativado.

  • LockType

    string

    O status do bloqueio do SIM. Os valores possíveis são 'sim-pin', 'sim-puk' e ''.

  • RetriesLeft

    número opcional

    Número de tentativas de bloqueio de PIN permitidas antes que o PUK seja necessário para desbloquear o chip.

ThirdPartyVPNProperties

Propriedades

  • ExtensionID

    string

    ID da extensão do provedor de VPN de terceiros.

  • ProviderName

    string opcional

    O nome do provedor de VPN.

VPNProperties

Propriedades

  • AutoConnect

    booleano opcional

    Se a rede VPN precisa ser conectada automaticamente.

  • Host

    string opcional

    O host da VPN.

  • Tipo

    string opcional

    O tipo de VPN. Não é possível usar um tipo enumerado devido a "L2TP-IPSec". Isso é opcional para NetworkConfigProperties, que é transmitido para setProperties, que pode ser usado para definir apenas propriedades específicas.

VPNStateProperties

Propriedades

WiFiProperties

Propriedades

  • AllowGatewayARPPolling

    booleano opcional

    Suspensa desde o Chrome 131

    Removido na versão M131. Não há sondagem ARP ativa no momento.

  • AutoConnect

    booleano opcional

    Se a rede Wi-Fi precisa ser conectada automaticamente quando estiver no alcance.

  • BSSID

    string opcional

    O BSSID do ponto de acesso associado.

  • EAP

    EAPProperties opcional

    As propriedades EAP da rede. Obrigatório para redes WEP-8021X e WPA-EAP.

  • Frequência

    número opcional

    A frequência de operação do serviço Wi-Fi em MHz. Para redes conectadas, a frequência atual em que a rede está conectada. Caso contrário, a frequência do melhor BSS disponível.

  • FrequencyList

    number[] opcional

    Contém todas as frequências de operação notadas recentemente para a rede Wi-Fi.

  • HexSSID

    string opcional

    Cópia codificada em HEX do SSID da rede.

  • HiddenSSID

    booleano opcional

    Se o SSID da rede será transmitido.

  • Senha

    string opcional

    Chrome 66 ou mais recente

    A senha longa para conexões WEP/WPA/WPA2. Essa propriedade só pode ser definida. As propriedades retornadas por getProperties não vão conter esse valor.

  • RoamThreshold

    número opcional

    Descontinuado e ignorado.

  • SSID

    string opcional

    O SSID da rede.

  • Segurança

    string opcional

    O tipo de segurança da rede.

  • SignalStrength

    número opcional

    A intensidade do sinal da rede.

WiFiStateProperties

Propriedades

WiMAXProperties

Propriedades

  • AutoConnect

    booleano opcional

    Indica se a rede precisa ser conectada automaticamente.

  • EAP

    EAPProperties opcional

    As propriedades EAP da rede.

Métodos

createNetwork()

Promessa 
chrome.networking.onc.createNetwork(
  shared: boolean,
  properties: NetworkConfigProperties,
  callback?: function,
)

Cria uma nova configuração de rede com base em propriedades. Se uma rede configurada correspondente já existir, isso vai falhar. Caso contrário, retorna o GUID da nova rede.

Parâmetros

  • compartilhados

    booleano

    Se true, compartilhe essa configuração de rede com outros usuários.

    Essa opção é exposta apenas para a interface da Web do Chrome.* Quando chamado por apps, false é o único valor permitido.

  • As propriedades para configurar a nova rede.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: string) => void

    • resultado

      string

Retorna

  • Promise<string>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

disableNetworkType()

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

Desativa todos os dispositivos que correspondem ao tipo de rede especificado. Consulte a observação para enableNetworkType.

Parâmetros

  • networkType

    NetworkType

    O tipo de rede a ser desativado.

enableNetworkType()

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

Ativa todos os dispositivos que correspondem ao tipo de rede especificado. O tipo pode representar vários tipos de rede (por exemplo, "Sem fio").

Parâmetros

  • networkType

    NetworkType

    O tipo de rede a ser ativado.

forgetNetwork()

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

Esquece uma configuração de rede limpando todas as propriedades configuradas para a rede com o GUID networkGuid. Isso também pode incluir qualquer outra rede com identificadores correspondentes (por exemplo, SSID e segurança do Wi-Fi). Se não houver essa configuração, um erro será definido e a operação falhará.

Em sessões de quiosque, esse método não poderá esquecer as configurações de rede compartilhadas.

Parâmetros

  • networkGuid

    string

    O GUID da rede a ser esquecida.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getCaptivePortalStatus()

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

Retorna o status do portal cativo para a rede que corresponde a "networkGuid".

Parâmetros

  • networkGuid

    string

    O GUID da rede para receber o status do portal cativo.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: CaptivePortalStatus) => void

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getDeviceStates()

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

Retorna os estados dos dispositivos de rede disponíveis.

Parâmetros

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getGlobalPolicy()

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

Consegue as propriedades da política global. Não é esperado que essas propriedades mudem durante uma sessão.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: GlobalPolicy) => void

Retorna

  • Promise<GlobalPolicy>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getManagedProperties()

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

Extrai as propriedades mescladas da rede com o ID networkGuid das seguintes fontes: configurações do usuário, configurações compartilhadas, política do usuário, política do dispositivo e configurações ativas no momento.

Parâmetros

  • networkGuid

    string

    O GUID da rede para receber propriedades.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: ManagedProperties) => void

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getNetworks()

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

Retorna uma lista de objetos de rede com as mesmas propriedades fornecidas por getState. Um filtro é fornecido para especificar o tipo de redes retornadas e limitar o número delas. As redes são ordenadas pelo sistema com base na prioridade, e as redes conectadas ou em processo de conexão são listadas primeiro.

Parâmetros

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getProperties()

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

Extrai todas as propriedades da rede com o ID networkGuid. Inclui todas as propriedades da rede (somente leitura e leitura/gravação).

Parâmetros

  • networkGuid

    string

    O GUID da rede para receber propriedades.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: NetworkProperties) => void

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getState()

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

Recebe as propriedades somente leitura em cache da rede com o id networkGuid. Essa é uma função de maior desempenho do que getProperties, que exige uma ida e volta para consultar o subsistema de rede. As propriedades a seguir são retornadas para todas as redes: GUID, Type, Name, WiFi.Security. Outras propriedades são fornecidas para redes visíveis: ConnectionState, ErrorState, WiFi.SignalStrength, Cellular.NetworkTechnology, Cellular.ActivationState, Cellular.RoamingState.

Parâmetros

Retorna

  • Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

requestNetworkScan()

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

Solicita que o subsistema de rede faça a verificação de novas redes e atualize a lista retornada por getVisibleNetworks. Essa é apenas uma solicitação: o subsistema de rede pode ignorá-la. Se a lista for atualizada, o evento onNetworkListChanged será acionado.

Parâmetros

  • networkType

    NetworkType opcional

    Chrome 63 ou mais recente

    Se fornecido, solicita uma verificação específica para o tipo. Para redes móveis, uma verificação de rede móvel será solicitada, se houver suporte.

setProperties()

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

Define as propriedades da rede com o id networkGuid. Isso é válido apenas para redes configuradas (Fonte != Nenhum). As redes visíveis não configuradas precisam usar createNetwork. Em sessões de quiosque, a chamada desse método em uma rede compartilhada vai falhar.

Parâmetros

  • networkGuid

    string

    O GUID da rede para definir propriedades.

  • As propriedades a serem definidas.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startConnect()

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

Inicia uma conexão com a rede usando networkGuid.

Parâmetros

  • networkGuid

    string

    O GUID da rede a que você quer se conectar.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startDisconnect()

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

Inicia uma desconexão da rede com networkGuid.

Parâmetros

  • networkGuid

    string

    O GUID da rede a ser desconectada.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 125+

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onDeviceStateListChanged

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

Acionado quando a lista de dispositivos ou qualquer propriedade do estado do dispositivo é alterada.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    () => void

onNetworkListChanged

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

Acionado quando a lista de redes muda. Envia uma lista completa de GUIDs para todas as redes atuais.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (changes: string[]) => void

    • muda

      string[]

onNetworksChanged

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

Acionada quando as propriedades mudam em qualquer uma das redes. Envia uma lista de GUIDs para redes com propriedades alteradas.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (changes: string[]) => void

    • muda

      string[]

onPortalDetectionCompleted

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

É disparado quando a detecção de um portal para uma rede é concluída. Envia o GUID da rede e o status do portal cativo correspondente.

Parâmetros