Google Apps Script API
    Preparing search index...

    Interface ContactsApp

    This class allows users to access their own Google Contacts and create, remove, and update contacts listed therein.

    interface ContactsApp {
        ExtendedField: typeof ExtendedField;
        Field: typeof GoogleAppsScript.Contacts.Field;
        Gender: typeof GoogleAppsScript.Contacts.Gender;
        Month: typeof Month;
        Priority: typeof Priority;
        Sensitivity: typeof Sensitivity;
        createContact(
            givenName: string,
            familyName: string,
            email: string,
        ): GoogleAppsScript.Contacts.Contact;
        createContactGroup(name: string): GoogleAppsScript.Contacts.ContactGroup;
        deleteContact(contact: GoogleAppsScript.Contacts.Contact): void;
        deleteContactGroup(group: GoogleAppsScript.Contacts.ContactGroup): void;
        findByEmailAddress(email: string): GoogleAppsScript.Contacts.Contact;
        findContactGroup(name: string): GoogleAppsScript.Contacts.ContactGroup;
        getAllContacts(): GoogleAppsScript.Contacts.Contact[];
        getContact(emailAddress: string): GoogleAppsScript.Contacts.Contact;
        getContactById(id: string): GoogleAppsScript.Contacts.Contact;
        getContactGroup(name: string): GoogleAppsScript.Contacts.ContactGroup;
        getContactGroupById(id: string): GoogleAppsScript.Contacts.ContactGroup;
        getContactGroups(): GoogleAppsScript.Contacts.ContactGroup[];
        getContacts(): GoogleAppsScript.Contacts.Contact[];
        getContactsByAddress(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByAddress(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByAddress(
            query: string,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByCompany(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByCustomField(
            query: string | typeof ExtendedField,
            label: ExtendedField,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByDate(
            month: Month,
            day: number,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByDate(
            month: Month,
            day: number,
            year: number,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByDate(
            month: Month,
            day: number,
            year: number,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByDate(
            month: Month,
            day: number,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByEmailAddress(
            query: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByEmailAddress(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByEmailAddress(
            query: string,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByGroup(
            group: GoogleAppsScript.Contacts.ContactGroup,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByIM(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByIM(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByIM(
            query: string,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByJobTitle(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByName(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByName(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByNotes(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByPhone(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByPhone(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByPhone(
            query: string,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByUrl(query: string): GoogleAppsScript.Contacts.Contact[];
        getContactsByUrl(
            query: string,
            label: GoogleAppsScript.Contacts.Field,
        ): GoogleAppsScript.Contacts.Contact[];
        getContactsByUrl(
            query: string,
            label: string,
        ): GoogleAppsScript.Contacts.Contact[];
    }
    Index

    Properties

    ExtendedField Field Gender Month Priority Sensitivity

    Methods

    createContact createContactGroup deleteContact deleteContactGroup findByEmailAddress findContactGroup getAllContacts getContact getContactById getContactGroup getContactGroupById getContactGroups getContacts getContactsByAddress getContactsByCompany getContactsByCustomField getContactsByDate getContactsByEmailAddress getContactsByGroup getContactsByIM getContactsByJobTitle getContactsByName getContactsByNotes getContactsByPhone getContactsByUrl

    Properties
    ExtendedField: typeof ExtendedField
    Field: typeof GoogleAppsScript.Contacts.Field
    Gender: typeof GoogleAppsScript.Contacts.Gender
    Month: typeof Month
    Priority: typeof Priority
    Sensitivity: typeof Sensitivity

    Methods

    Settings
    Member Visibility

    On This Page
    Properties
    Methods