SuperApp:Contacts

A API JS WVContacts oferece métodos para gerenciar permissões e dados de contatos em aplicativos H5 e mini programs.

WVContacts.askAuth

Solicita autorização para acessar os contatos do dispositivo.

Parâmetros

Este método não aceita parâmetros.

Parâmetros de callback

Em dispositivos com iOS 6 ou posterior, o callback success é sempre acionado e retorna o status de autorização. Em versões anteriores do iOS, nenhum callback é acionado e nenhuma solicitação de autorização é feita.

• [int] isAuthed: Indica se o usuário concedeu autorização. 0: não concedida. 1: concedida.

window.WindVane.call('WVContacts', 'askAuth', {}, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.authStatus

Retorna o status atual de autorização para acesso aos contatos.

Parâmetros

Este método não aceita parâmetros.

Parâmetros de callback

O callback success é sempre acionado.

• [int] isAuthed: Indica se a autorização foi concedida. 0: não concedida. 1: concedida.

• [int] status: (iOS only) Status detalhado de autorização no iOS. Valores válidos:

  • 0: Não determinado.

  • 1: Restrito.

  • 2: Negado.

  • 3: Autorizado.

window.WindVane.call('WVContacts', 'authStatus', {}, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.escolha

Abre a lista de contatos do dispositivo para que o usuário selecione um contato e retorna o nome e o número de telefone do contato selecionado para o aplicativo H5.

Parâmetros

Este método não aceita parâmetros.

Parâmetros de callback

O callback success é acionado quando o usuário seleciona um contato. O callback failure é acionado se o usuário cancelar a operação.

• [string] name: Nome do contato selecionado.

• [string] phone: Número de telefone do contato selecionado.

window.WindVane.call('WVContacts', 'choose', {}, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e))
});

WVContacts.find

Pesquisa contatos por nome, número de telefone ou ambos.

Parâmetros

• [object] filter: Critérios de pesquisa. Contém as seguintes propriedades:

  • [string] name: Opcional. Corresponde a contatos cujo nome contém esta string (correspondência parcial no iOS).

  • [string] phone: Opcional. Corresponde a contatos cujo número de telefone contém esta string (correspondência parcial no iOS).

Quando name e phone são especificados, apenas os contatos que correspondem a ambos os critérios são retornados. Se um contato tiver vários números de telefone, cada número correspondente aparecerá como uma entrada separada nos resultados.

Parâmetros de callback

O callback success é sempre acionado.

• [array] contacts: Contatos que correspondem ao filtro. Cada item contém:

  • [string] name: Nome do contato.

  • [string] phone: Número de telefone do contato.

var params = {
        // Search criteria.
        filter: {
                // Match contacts by name.
                name: 'John',
                // Match contacts by phone number.
                phone: '123456'
        }
}
window.WindVane.call('WVContacts', 'find', params, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.addPhoneContact

Adiciona um novo contato à lista de contatos do dispositivo.

Parâmetros

• [string] lastName: Obrigatório. Sobrenome do contato.

• [string] firstName: Obrigatório. Nome do contato.

• [string] middleName: Opcional. Nome do meio do contato.

• [string] nickName: Opcional. Apelido do contato.

• [string] remark: Opcional. Observação sobre o contato.

• [string] mobilePhoneNumber: Opcional. Número de telefone celular do contato.

• [string] hostNumber: Opcional. Número de telefone comercial ou residencial do contato.

• [string] address: Opcional. Endereço do contato.

• [string] email: Opcional. Endereço de e-mail do contato.

• [string] organization: Opcional. Organização do contato.

• [string] title: Opcional. Cargo do contato.

• [string] photoPath: Opcional. Caminho do arquivo local para a foto do contato.

Parâmetros de callback

Em caso de sucesso:

• Nenhum.

Em caso de falha:

• [string] msg: Mensagem de erro.

var params = {
  lastName: 'Smith',
  firstName: 'John',
  middleName: 'Michael',
  nickName: 'Johnny',
  remark: 'Met at conference',
  mobilePhoneNumber: '+86 13800138000',
  hostNumber: '010-12345678',
  address: 'Beijing, Chaoyang District',
  email: 'john.smith@example.com',
  organization: 'Alibaba Cloud',
  title: 'Software Engineer',
  photoPath: '/storage/emulated/0/DCIM/Camera/photo.jpg'
}

window.WindVane.call('WVContacts', 'addPhoneContact', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e))
});