Google Apps Script API
    Preparing search index...

    Interface Contact

    A Contact contains the name, address, and various contact details of a contact.

    interface Contact {
        addAddress(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            address: string,
        ): AddressField;
        addCompany(company: string, title: string): CompanyField;
        addCustomField(
            label: string | typeof ExtendedField,
            content: any,
        ): CustomField;
        addDate(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            month: Month,
            day: number,
            year: number,
        ): DateField;
        addEmail(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            address: string,
        ): EmailField;
        addIM(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            address: string,
        ): IMField;
        addPhone(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            number: string,
        ): PhoneField;
        addToGroup(
            group: GoogleAppsScript.Contacts.ContactGroup,
        ): GoogleAppsScript.Contacts.Contact;
        addUrl(
            label: string | typeof GoogleAppsScript.Contacts.Field,
            url: string,
        ): UrlField;
        deleteContact(): void;
        getAddresses(): AddressField[];
        getAddresses(
            label: string | typeof GoogleAppsScript.Contacts.Field,
        ): AddressField[];
        getCompanies(): CompanyField[];
        getContactGroups(): GoogleAppsScript.Contacts.ContactGroup[];
        getCustomFields(): CustomField[];
        getCustomFields(label: string | typeof ExtendedField): CustomField[];
        getDates(): DateField[];
        getDates(
            label: string | typeof GoogleAppsScript.Contacts.Field,
        ): DateField[];
        getEmailAddresses(): string[];
        getEmails(): EmailField[];
        getEmails(
            label: string | typeof GoogleAppsScript.Contacts.Field,
        ): EmailField[];
        getFamilyName(): string;
        getFullName(): string;
        getGivenName(): string;
        getHomeAddress(): string;
        getHomeFax(): string;
        getHomePhone(): string;
        getId(): string;
        getIMs(): IMField[];
        getIMs(label: string | typeof GoogleAppsScript.Contacts.Field): IMField[];
        getInitials(): string;
        getLastUpdated(): GoogleAppsScript.Base.Date;
        getMaidenName(): string;
        getMiddleName(): string;
        getMobilePhone(): string;
        getNickname(): string;
        getNotes(): string;
        getPager(): string;
        getPhones(): PhoneField[];
        getPhones(
            label: string | typeof GoogleAppsScript.Contacts.Field,
        ): PhoneField[];
        getPrefix(): string;
        getPrimaryEmail(): string;
        getShortName(): string;
        getSuffix(): string;
        getUrls(): UrlField[];
        getUrls(label: string | typeof GoogleAppsScript.Contacts.Field): UrlField[];
        getUserDefinedField(key: string): string;
        getUserDefinedFields(): object;
        getWorkAddress(): string;
        getWorkFax(): string;
        getWorkPhone(): string;
        removeFromGroup(
            group: GoogleAppsScript.Contacts.ContactGroup,
        ): GoogleAppsScript.Contacts.Contact;
        setFamilyName(familyName: string): GoogleAppsScript.Contacts.Contact;
        setFullName(fullName: string): GoogleAppsScript.Contacts.Contact;
        setGivenName(givenName: string): GoogleAppsScript.Contacts.Contact;
        setHomeAddress(addr: string): void;
        setHomeFax(phone: string): void;
        setHomePhone(phone: string): void;
        setInitials(initials: string): GoogleAppsScript.Contacts.Contact;
        setMaidenName(maidenName: string): GoogleAppsScript.Contacts.Contact;
        setMiddleName(middleName: string): GoogleAppsScript.Contacts.Contact;
        setMobilePhone(phone: string): void;
        setNickname(nickname: string): GoogleAppsScript.Contacts.Contact;
        setNotes(notes: string): GoogleAppsScript.Contacts.Contact;
        setPager(phone: string): void;
        setPrefix(prefix: string): GoogleAppsScript.Contacts.Contact;
        setPrimaryEmail(primaryEmail: string): void;
        setShortName(shortName: string): GoogleAppsScript.Contacts.Contact;
        setSuffix(suffix: string): GoogleAppsScript.Contacts.Contact;
        setUserDefinedField(key: string, value: string): void;
        setUserDefinedFields(o: object): void;
        setWorkAddress(addr: string): void;
        setWorkFax(phone: string): void;
        setWorkPhone(phone: string): void;
    }
    Index

    Methods

    addAddress addCompany addCustomField addDate addEmail addIM addPhone addToGroup addUrl deleteContact getAddresses getCompanies getContactGroups getCustomFields getDates getEmailAddresses getEmails getFamilyName getFullName getGivenName getHomeAddress getHomeFax getHomePhone getId getIMs getInitials getLastUpdated getMaidenName getMiddleName getMobilePhone getNickname getNotes getPager getPhones getPrefix getPrimaryEmail getShortName getSuffix getUrls getUserDefinedField getUserDefinedFields getWorkAddress getWorkFax getWorkPhone removeFromGroup setFamilyName setFullName setGivenName setHomeAddress setHomeFax setHomePhone setInitials setMaidenName setMiddleName setMobilePhone setNickname setNotes setPager setPrefix setPrimaryEmail setShortName setSuffix setUserDefinedField setUserDefinedFields setWorkAddress setWorkFax setWorkPhone

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    addAddress addCompany addCustomField addDate addEmail addIM addPhone addToGroup addUrl deleteContact getAddresses getCompanies getContactGroups getCustomFields getDates getEmailAddresses getEmails getFamilyName getFullName getGivenName getHomeAddress getHomeFax getHomePhone getId getIMs getInitials getLastUpdated getMaidenName getMiddleName getMobilePhone getNickname getNotes getPager getPhones getPrefix getPrimaryEmail getShortName getSuffix getUrls getUserDefinedField getUserDefinedFields getWorkAddress getWorkFax getWorkPhone removeFromGroup setFamilyName setFullName setGivenName setHomeAddress setHomeFax setHomePhone setInitials setMaidenName setMiddleName setMobilePhone setNickname setNotes setPager setPrefix setPrimaryEmail setShortName setSuffix setUserDefinedField setUserDefinedFields setWorkAddress setWorkFax setWorkPhone