Obsoleto. Em vez disso, use o serviço avançado da API People.
Um ContactGroup é um grupo de contatos.
Métodos obsoletos
Método | Tipo de retorno | Breve descrição |
---|---|---|
|
| Adiciona o contato fornecido a este grupo |
| void | Exclui este grupo de contatos. |
|
| Mostra todos os contatos neste grupo de contatos. |
| String | Retorna o nome desse grupo. |
| String | Extrai o ID desse grupo de contatos. |
| String | Extrai o nome desse grupo de contatos. |
| Boolean | Recebe um valor booleano para determinar se esse grupo de contatos é um grupo do sistema (não eletrível) ou não. |
|
| Remove o contato especificado deste grupo |
| void | Define o nome deste grupo. |
|
| Define o nome desse grupo de contatos. |
Métodos obsoletos
addContact(contact)
addContact(contact)
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Adiciona o contato fornecido a este grupo
// The code below creates a new contact and adds it to the "Work Friends" contact group var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com'); var group = ContactsApp.getContactGroup('Work Friends'); group.addContact(contact);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
contact |
| o contato a ser adicionado ao grupo |
Retorno
: este grupo de contatosContactGroup
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
Veja também
deleteGroup()
deleteGroup()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Exclui este grupo de contatos.
Exclui apenas grupos que não são do sistema. Grupos do sistema não podem ser excluídos.
// The code below retrieves a contact group named "Work Friends" and deletes it var group = ContactsApp.getContactGroup('Work Friends'); group.deleteGroup();
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
Veja também
getContacts()
getContacts()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Mostra todos os contatos neste grupo de contatos.
// The code below retrieves all the contacts in the group named "Work Friends" var group = ContactsApp.getContactGroup('Work Friends'); var contacts = group.getContacts();
Retorno
: são os contatos neste grupo.Contact[]
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
getGroupName()
getGroupName()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Retorna o nome desse grupo.
Retorno
String
: o nome deste grupo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
getId()
getId()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Extrai o ID desse grupo de contatos.
// The code below retrieves a contact group named "Work Friends" and gets its id var group = ContactsApp.getContactGroup('Work Friends'); var id = group.getId();
Retorno
String
: o ID deste grupo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
getName()
getName()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Extrai o nome desse grupo de contatos.
// The code below creates a new contact group and then retrieves its name var group = ContactsApp.createContactGroup('Work Friends'); var name = group.getName();
Retorno
String
: este nome do grupo de contatos.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
Veja também
isSystemGroup()
isSystemGroup()
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Recebe um valor booleano para determinar se esse grupo de contatos é um grupo do sistema (não eletrível) ou não.
Grupos de sistemas são conjuntos predefinidos nos Contatos do Google, como "Meus contatos", "Família", "Colegas de trabalho" etc. O nome de um grupo do sistema geralmente contém as palavras "Grupo do sistema".
// The code below retrieves two contact groups, then logs whether or not // each is a system group. var myGroup = ContactsApp.getContactGroup('Work Friends'); var systemGroup = ContactsApp.getContactGroup('System Group: Coworkers'); Logger.log(myGroup.isSystemGroup()); // Returns false, if the group exists. Logger.log(systemGroup.isSystemGroup()); // Returns true.
Retorno
Boolean
: se o grupo de contatos é ou não um grupo do sistema.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
removeContact(contact)
removeContact(contact)
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Remove o contato especificado deste grupo
// The code below retrieves all the contacts named "John Doe' and removes them from the // "Work Friends" contact group var contacts = ContactsApp.getContactsByName('John Doe'); var group = ContactsApp.getContactGroup('Work Friends'); for (var i in contacts) { group.removeContact(contacts[i]); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
contact |
| o contato a ser removido do grupo |
Retorno
: este grupo de contatosContactGroup
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
Veja também
setGroupName(name)
setGroupName(name)
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Define o nome deste grupo.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome a ser definido para este grupo |
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds
setName(name)
setName(name)
Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.
Define o nome desse grupo de contatos.
// The code below retrieves the contact group named "Work Friends" and renames it to // "Work Buddies" var group = ContactsApp.getContactGroup('Work Friends'); group.setName('Work Buddies');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o novo nome do grupo de contatos |
Retorno
: este grupo de contatosContactGroup
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.google.com/m8/feeds