Um seletor de contatos para a Web

A API Contact Picker oferece uma maneira fácil de compartilhar contatos da lista de contatos.

O acesso aos contatos do usuário em um dispositivo móvel é um recurso dos apps iOS/Android desde (quase) o início dos tempos. Esse é um dos pedidos de recursos mais comuns que ouço de desenvolvedores da Web e, muitas vezes, é o principal motivo pelo qual eles criam um app iOS/Android.

Disponível no Chrome 80 no Android M ou versões mais recentes, a especificação da API Contact Picker é uma API sob demanda que permite aos usuários selecionar entradas da lista de contatos e compartilhar detalhes limitados das entradas selecionadas com um site. Ele permite que os usuários compartilhem apenas o que querem, quando querem, e facilita o contato e a conexão com amigos e familiares.

Por exemplo, um cliente de e-mail baseado na Web pode usar a API Contact Picker para selecionar os destinatários de um e-mail. Um app de VoIP pode procurar qual número de telefone ligar. Ou uma rede social pode ajudar um usuário a descobrir quais amigos já estão registrados.

Como usar a API Contact Picker

A API Contact Picker exige uma chamada de método com um parâmetro de opções que especifica os tipos de informações de contato que você quer. Um segundo método informa quais informações o sistema vai fornecer.

Detecção de recursos

Para verificar se a API Contact Picker é compatível, use:

const supported = ('contacts' in navigator && 'ContactsManager' in window);

Além disso, no Android, o seletor de contatos exige o Android M ou mais recente.

Como abrir o seletor de contatos

O ponto de entrada da API Contact Picker é navigator.contacts.select(). Quando chamado, ele retorna uma promessa e mostra o seletor de contatos, permitindo que o usuário selecione os contatos que ele quer compartilhar com o site. Depois de selecionar o que compartilhar e clicar em Done, a promessa é resolvida com uma matriz de contatos selecionados pelo usuário.

Ao chamar select(), você precisa fornecer uma matriz de propriedades que gostaria de retornar como o primeiro parâmetro (com os valores permitidos sendo qualquer um de 'name', 'email', 'tel', 'address' ou 'icon'), e, opcionalmente, se vários contatos podem ser selecionados como um segundo parâmetro.

const props = ['name', 'email', 'tel', 'address', 'icon'];
const opts = {multiple: true};

try {
 
const contacts = await navigator.contacts.select(props, opts);
  handleResults
(contacts);
} catch (ex) {
 
// Handle any errors here.
}

A API Contacts Picker só pode ser chamada de um contexto de navegação de nível superior seguro. Como outras APIs avançadas, ela exige um gesto do usuário.

Como detectar propriedades disponíveis

Para detectar quais propriedades estão disponíveis, chame navigator.contacts.getProperties(). Ele retorna uma promessa que é resolvida com uma matriz de strings indicando quais propriedades estão disponíveis. Por exemplo, ['name', 'email', 'tel', 'address']. É possível transmitir esses valores para select().

Lembre-se de que as propriedades nem sempre estão disponíveis e novas propriedades podem ser adicionadas. No futuro, outras plataformas e fontes de contato poderão restringir quais propriedades serão compartilhadas.

Como processar os resultados

A API Contact Picker retorna uma matriz de contatos, e cada contato inclui uma matriz das propriedades solicitadas. Se um contato não tiver dados para a propriedade solicitada ou se o usuário optar por não compartilhar uma propriedade específica, a API vai retornar uma matriz vazia. Descrevemos como o usuário escolhe propriedades na seção Controle do usuário.

Por exemplo, se um site solicitar name, email e tel, e um usuário selecionar um único contato que tenha dados no campo de nome, forneça dois números de telefone, mas não tenha um endereço de e-mail, a resposta será:

[{
 
"email": [],
 
"name": ["Queen O'Hearts"],
 
"tel": ["+1-206-555-1000", "+1-206-555-1111"]
}]

Segurança e permissões

A equipe do Chrome projetou e implementou a API Contact Picker usando os princípios principais definidos em Como controlar o acesso a recursos poderosos da plataforma da Web, incluindo controle do usuário, transparência e ergonomia. Vou explicar cada uma delas.

Controle do usuário

O acesso aos contatos dos usuários é feito pelo seletor e só pode ser chamado com um gesto do usuário, em um contexto de navegação de nível superior seguro. Isso garante que um site não possa mostrar o seletor no carregamento de página ou mostrar aleatoriamente o seletor sem qualquer contexto.

Captura de tela: os usuários podem escolher quais propriedades compartilhar.
O usuário pode escolher não compartilhar algumas propriedades. Nesta captura de tela, o usuário desmarcou o botão "Números de telefone". Mesmo que o site solicite números de telefone, eles não serão compartilhados com a plataforma.

Não há uma opção para selecionar todos os contatos em massa, para que os usuários sejam incentivados a selecionar apenas os contatos que precisam compartilhar para esse site específico. Os usuários também podem controlar quais propriedades são compartilhadas com o site alternando o botão de propriedade na parte de cima do seletor.

Transparência

Para esclarecer quais detalhes de contato estão sendo compartilhados, o seletor sempre mostra o nome e o ícone do contato, além de todas as propriedades solicitadas pelo site. Por exemplo, se um site solicitar name, email e tel, as três propriedades serão mostradas no seletor. Como alternativa, se um site solicitar apenas tel, o seletor vai mostrar apenas o nome e os números de telefone.

Captura de tela do seletor para o site que solicita todas as propriedades.
Picker, site solicitando name, email e tel, um contato selecionado.
Captura de tela do seletor para o site que solicita apenas números de telefone.
Seletor, site solicitando apenas tel, um contato selecionado.
Captura de tela do seletor quando um contato é tocado e pressionado.
O resultado de tocar e manter pressionado um contato.

Um toque longo em um contato mostra todas as informações que serão compartilhadas se o contato for selecionado. (Consulte a imagem do contato do Cheshire Cat.)

Sem persistência de permissão

O acesso aos contatos é sob demanda e não é mantido. Sempre que um site quiser acesso, ele precisará chamar navigator.contacts.select() com um gesto do usuário, e o usuário precisará escolher individualmente os contatos que quer compartilhar com o site.

Feedback

A equipe do Chrome quer saber mais sobre suas experiências com a API Contact Picker.

Problemas com a implementação?

Você encontrou um bug na implementação do Chrome? Ou a implementação é diferente da especificação?

  • Registre um bug em https://new.crbug.com. Inclua o máximo de detalhes possível, forneça instruções simples para reproduzir o bug e defina Components como Blink>Contacts. O Glitch (link em inglês) funciona muito bem para compartilhar reproduções rápidas e fáceis de problemas.

Planeja usar a API?

Você planeja usar a API Contact Picker? Seu apoio público ajuda a equipe do Chrome a priorizar recursos e mostra a outros fornecedores de navegadores como é fundamental oferecer suporte a eles.

Links úteis

Obrigado

Agradecemos a Finnur Thorarinsson e Rayan Kanso, que estão implementando o recurso, e a Peter Beverloo, cujo código foi descaradamente roubado e refatorado para a demonstração.

Observação: os nomes no seletor de contatos são personagens de Alice no País das Maravilhas.