chrome.networking.onc

Descrição

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

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

OBSERVAÇÃO: a maioria das propriedades de dicionário e dos valores de enumeração usa maiúsculas e minúsculas em maiúsculas e minúsculas para corresponder à especificação ONC em vez da convenção lowerCamelCase do JavaScript.

Permissões

networking.onc

Disponibilidade

Chrome 59+ Apenas no ChromeOS

Tipos

ActivationStateType

Tipo enumerado

CaptivePortalStatus

Tipo enumerado

"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 na rede.

  • AutoConnect

    booleano opcional

    Define se a rede celular 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 de firmware foi 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 de modem celular.

  • HomeProvider

    CellularProviderProperties opcional

    Informações sobre o operador que emitiu o chip atualmente 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, isso significa que a tecnologia de rede está em uso no momento.

  • 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 familiares GSM.

  • SIMPresent

    booleano opcional

    Se há um chip.

  • Verificação

    booleano opcional

    Chrome 63 ou mais recente

    Verdadeiro 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

    Indica se a rede celular oferece suporte à busca.

CellularProviderProperties

Propriedades

  • Programar

    string

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

  • País

    string opcional

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

  • Nome

    string

    O nome do operador.

CellularStateProperties

Propriedades

CertificatePattern

Propriedades

  • EnrollmentURI

    string[] opcional

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

  • Emissor

    IssuerSubjectPattern opcional

    Se definido, o padrão com o qual as configurações do emissor X.509 devem ser correspondidas.

  • IssuerCARef

    string[] opcional

    Lista de certificados de CA do emissor do certificado. Um certificado precisa ser assinado por uma delas para corresponder a esse padrão.

  • Assunto

    IssuerSubjectPattern opcional

    Se definido, o padrão com o qual as configurações de assunto X.509 devem ser correspondidas.

ClientCertificateType

Tipo enumerado

"Ref"

ConnectionStateType

Tipo enumerado

DeviceStateProperties

Propriedades

  • SIMLockStatus

    SIMLockStatus opcional

    Chrome 62 ou mais recente

    O status de bloqueio do chip se Tipo = Celular e SIMPresent = Verdadeiro.

  • SIMPresent

    booleano opcional

    Chrome 62 ou mais recente

    Defina como o estado atual do chip se o tipo de dispositivo for "Rede celular".

  • Verificação

    booleano opcional

    Defina se o dispositivo está ativado. "Verdadeiro" se o dispositivo estiver fazendo a verificação no momento.

  • O estado atual do dispositivo.

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

DeviceStateType

Tipo enumerado

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

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

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

"Ativado"
O dispositivo está ativado.

"Proibido"
O dispositivo é proibido.

EAPProperties

Propriedades

  • AnonymousIdentity

    string opcional

  • ClientCertPKCS11Id

    string opcional

    Chrome 60 ou mais recente
  • ClientCertPattern

    CertificatePattern opcional

  • ClientCertProvisioningProfileId

    string opcional

    Chrome 93 ou mais recente
  • ClientCertRef

    string opcional

  • ClientCertType

    ClientCertificateType

  • Identidade

    string opcional

  • Inner

    string opcional

  • Externo

    string opcional

    O tipo de EAP externo. Exigido 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 ou mais recente
  • UseProactiveKeyCaching

    booleano opcional

  • UseSystemCAs

    booleano opcional

EthernetProperties

Propriedades

  • Proporção de Eficiência Energética (EER)

    string opcional

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

  • AutoConnect

    booleano opcional

    Se a rede Ethernet deve ser conectada automaticamente.

  • EAP

    EAPProperties opcional

    Configurações de EAP da rede. Obrigatório para a autenticação 8021X.

EthernetStateProperties

Propriedades

FoundNetworkProperties

Propriedades

  • LongName

    string opcional

    O nome em formato longo do operador de rede.

  • NetworkId

    string

    ID da rede.

  • ShortName

    string opcional

    O nome de formato curto do operador de rede.

  • Status

    string

    Disponibilidade de rede.

  • Tecnologia

    string

    Tecnologia de acesso usada pela rede.

GlobalPolicy

Propriedades

  • AllowOnlyPolicyNetworksToAutoconnect

    booleano opcional

    Se verdadeiro, apenas redes de política podem se conectar automaticamente. O padrão é "false".

  • AllowOnlyPolicyNetworksToConnect

    booleano opcional

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

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    booleano opcional

    Chrome 70 ou mais recente

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

  • BlockedHexSSIDs

    string[] opcional

    Chrome 86 ou mais recente

    Lista de redes bloqueadas. Conexões com redes bloqueadas são proibidas. As redes podem ser desbloqueadas novamente especificando uma configuração de rede explícita. O padrão é uma lista vazia.

IPConfigProperties

Propriedades

  • ExcludedRoutes

    string[] opcional

    Chrome 76 ou mais recente

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

  • Gateway

    string opcional

    Endereço do 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 ou mais recente

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

  • NameServers

    string[] opcional

    Matriz de endereços usada para servidores de nomes.

  • RoutingPrefix

    número opcional

    O prefixo de roteamento.

  • SearchDomains

    string[] opcional

    Chrome 76 ou mais recente

    Matriz de strings para resolução de nome. Confira mais detalhes em onc_spec.md.

  • Tipo

    string opcional

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

  • WebProxyAutoDiscoveryUrl

    string opcional

    É o URL da descoberta automática do proxy WEb, conforme relatado por DHCP.

IPConfigType

Tipo enumerado

"DHCP"

IssuerSubjectPattern

Propriedades

  • CommonName

    string opcional

    Se definido, o valor que deve corresponder ao nome real do assunto do certificado.

  • Localidade

    string opcional

    Se definido, o valor que deve corresponder ao local comum do assunto do certificado.

  • Organização

    string opcional

    Se definido, o valor usado para corresponder às organizações do sujeito do certificado. Pelo menos uma organização precisa corresponder ao valor.

  • OrganizationalUnit

    string opcional

    Se definido, o valor que deve corresponder às 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

    Se há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    booleano opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    booleano opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas 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

    Se há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    string opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    string opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas 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

    Se há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    string[] opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    string[] opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas 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 há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    IPConfigType opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    IPConfigType opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas 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

    Se há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    número opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    número opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas 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 há um DevicePolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). O valor padrão é false.

  • DevicePolicy

    ProxySettingsType opcional

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

  • Efetivo

    string opcional

    A fonte a partir da qual o valor da propriedade efetiva foi determinado.

  • SharedSetting

    ProxySettingsType opcional

    O valor definido para todos os usuários do dispositivo. Fornecido apenas se DeviceEditiable for true.

  • UserEditable

    booleano opcional

    Indica se há um UserPolicy para a propriedade e permite que ela seja editada (ou seja, o valor da propriedade recomendado pela política definida). 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. Fornecido apenas se UserEditable for true.

ManagedThirdPartyVPNProperties

Propriedades

ManagedVPNProperties

Propriedades

ManagedWiFiProperties

Propriedades

ManualProxySettings

Propriedades

  • FTPProxy

    ProxyLocation opcional

    Configurações do proxy do FTP.

  • HTTPProxy

    ProxyLocation opcional

    Configurações do proxy HTTP.

  • SOCAS

    ProxyLocation opcional

    Configurações do proxy SOCKS.

  • SecureHTTPProxy

    ProxyLocation opcional

    Configurações de proxy HTTP seguro.

NetworkConfigProperties

Propriedades

NetworkFilter

Propriedades

  • configurado

    booleano opcional

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

  • limite

    número opcional

    Número máximo de redes a serem retornadas. Se não for especificado, o padrão será 1.000. Use 0 se não houver limite.

  • networkType

    NetworkType

    O tipo de redes a serem retornadas.

  • visível

    booleano opcional

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

NetworkProperties

Propriedades

  • Rede celular

    CellularProperties opcional

    Para redes celulares, as propriedades da rede celular.

  • Conectável

    booleano opcional

    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 do IP da rede.

  • MacAddress

    string opcional

    Endereço MAC da rede.

  • Limitada

    booleano opcional

    Chrome 85 ou mais recente

    Se a rede é limitada.

  • Nome

    string opcional

    Um nome de rede fácil de usar.

  • NameServersConfigType

    IPConfigType opcional

    O tipo de configuração de IP para os 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 de rede com a Internet é limitada, por exemplo, se a rede estiver protegida por um portal ou se uma rede celular não estiver ativada.

  • SavedIPConfig

    IPConfigProperties opcional

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

  • Fonte

    string opcional

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

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    "Nenhum" entra em conflito com a geração de código de extensão, então precisamos usar uma string para "Origem" em vez de um tipo enumerado SourceType.

  • StaticIPConfig

    IPConfigProperties opcional

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

  • TrafficCounterResetTime

    número opcional

    Pendente

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

  • O tipo de rede.

  • VPN

    VPNProperties opcional

    Para redes VPN, as propriedades da VPN da rede.

  • WiFi

    WiFiProperties opcional

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

NetworkStateProperties

Propriedades

NetworkType

Tipo enumerado

"Ethernet"

"VPN"

PaymentPortal

Propriedades

  • Método

    string

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

  • PostData

    string opcional

    Os dados da postagem a serem enviados para o 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 que será usada com o proxy.

ProxySettings

Propriedades

  • ExcludeDomains

    string[] opcional

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

  • Manual

    ManualProxySettings opcional

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

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

    string opcional

    URL do arquivo de configuração automática do proxy.

  • O tipo de configuração de proxy.

ProxySettingsType

Tipo enumerado

"Manual"

"PAC"

"WPAD"

SIMLockStatus

Propriedades

  • LockEnabled

    boolean

    Se o bloqueio do chip está ativado.

  • LockType

    string

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

  • RetriesLeft

    número opcional

    O número de tentativas de bloqueio com PIN são 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 da VPN.

VPNProperties

Propriedades

  • AutoConnect

    booleano opcional

    Define se a rede VPN será conectada automaticamente.

  • Host

    string opcional

    O host da VPN.

  • Tipo

    string opcional

    O tipo de VPN. Este não pode ser um tipo enumerado por causa de "L2TP-IPSec". É opcional para NetworkConfigProperties, que é transmitido para setProperties, que pode ser usado para definir apenas propriedades específicas.

VPNStateProperties

Propriedades

WiFiProperties

Propriedades

  • AllowGatewayARPPolling

    booleano opcional

    Indica se a pesquisa ARP do gateway padrão é permitida. O padrão é verdadeiro (true).

  • AutoConnect

    booleano opcional

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

  • BSSID

    string opcional

    O BSSID do ponto de acesso associado.

  • EAP

    EAPProperties opcional

    As propriedades do EAP da rede. Obrigatório para as 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 toda a frequência de operação vista recentemente para a rede Wi-Fi.

  • HexSSID

    string opcional

    Cópia codificada em hexadecimal do SSID da rede.

  • HiddenSSID

    booleano opcional

    Indica se o SSID da rede será transmitido.

  • Senha longa

    string opcional

    Chrome 66 ou mais recente

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

  • RoamThreshold

    número opcional

    Obsoleto, ignorado.

  • SSID

    string opcional

    O SSID da rede.

  • Segurança

    string opcional

    O tipo de segurança de rede.

  • SignalStrength

    número opcional

    A intensidade do sinal da rede.

WiFiStateProperties

Propriedades

WiMAXProperties

Propriedades

  • AutoConnect

    booleano opcional

    Se a rede deve ser conectada automaticamente.

  • EAP

    EAPProperties opcional

    As propriedades do EAP da rede.

Métodos

createNetwork()

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

Cria uma configuração de rede com base nas propriedades. Se já existir uma rede configurada correspondente, ocorrerá uma falha. Caso contrário, retorna o GUID da nova rede.

Parâmetros

  • compartilhados

    boolean

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

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

  • As propriedades com as quais configurar a nova rede.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: string)=>void

    • resultado

      string

Retorna

  • Promessa<string>

    Pendente

    Promessas são compatíveis apenas com 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 correspondam ao tipo de rede especificado. Consulte a observação para enableNetworkType.

Parâmetros

  • networkType

    NetworkType

    O tipo de rede a ser desativada.

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

forgetNetwork()

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

Esquece uma configuração de rede ao limpar todas as propriedades configuradas com o GUID networkGuid. Isso também pode incluir outras redes com identificadores correspondentes (por exemplo, SSID do Wi-Fi e Segurança). Se essa configuração não existir, um erro será definido e a operação falhará.

Em sessões de quiosque, não é possível esquecer as configurações de rede compartilhadas com esse método.

Parâmetros

  • networkGuid

    string

    O GUID da rede a ser esquecido.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Pendente

    Promessas são compatíveis apenas com 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 correspondente a "networkGuid".

Parâmetros

  • networkGuid

    string

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: CaptivePortalStatus)=>void

Retorna

  • Pendente

    Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getDeviceStates()

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

Retorna estados de dispositivos de rede disponíveis.

Parâmetros

Retorna

  • Pendente

    Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getGlobalPolicy()

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

Recebe as propriedades da política global. Não esperamos que essas propriedades mudem durante uma sessão.

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: GlobalPolicy)=>void

Retorna

  • Promise<GlobalPolicy>

    Pendente

    Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getManagedProperties()

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

Recebe as propriedades mescladas da rede com o ID networkGuid das origens: 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 com as propriedades que serão buscadas.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: ManagedProperties)=>void

Retorna

  • Pendente

    Promessas são compatíveis apenas com 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 de redes. As redes são ordenadas pelo sistema com base na prioridade, com as redes conectadas ou conectadas primeiro.

Parâmetros

Retorna

  • Pendente

    Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getProperties()

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

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

Parâmetros

  • networkGuid

    string

    O GUID da rede com as propriedades que serão buscadas.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (result: NetworkProperties)=>void

Retorna

  • Pendente

    Promessas são compatíveis apenas com 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. Ela precisa ser uma função de desempenho mais alto 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

  • Pendente

    Promessas são compatíveis apenas com 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 verifique se há novas redes e atualize a lista retornada por getVisibleNetworks. Isso é apenas uma solicitação: o subsistema da rede pode optar por ignorá-la. Se a lista for atualizada, o evento onNetworkListChanged será disparado.

Parâmetros

  • networkType

    NetworkType opcional

    Chrome 63 ou mais recente

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

setProperties()

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

Define as propriedades da rede com o ID networkGuid. Válido somente para redes configuradas (Origem != Nenhuma). Redes visíveis não configuradas precisam usar createNetwork. Em sessões de quiosque, a chamada desse método em uma rede compartilhada falhará.

Parâmetros

  • networkGuid

    string

    O GUID da rede para a qual as propriedades serão definidas.

  • Propriedades a serem definidas.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Pendente

    Promessas são compatíveis apenas com 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 com networkGuid.

Parâmetros

  • networkGuid

    string

    O GUID da rede a ser conectada.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Pendente

    Promessas são compatíveis apenas com 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 optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Pendente

    Promessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onDeviceStateListChanged

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

Disparado quando a lista de dispositivos é alterada ou as propriedades de estado do dispositivo são alteradas.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    ()=>void

onNetworkListChanged

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

Disparado quando a lista de redes é alterada. Envia uma lista completa de GUIDs para todas as redes atuais.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (changes: string[])=>void

    • Mudanças

      string[]

onNetworksChanged

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (changes: string[])=>void

    • Mudanças

      string[]

onPortalDetectionCompleted

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

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

Parâmetros