Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Guides   Examples
New in version: 7.3   7.4   7.5   8.0   8.1   8.2   8.3   8.4   8.5   8.6    Statistic  

Component: Addressbook

Functions for the Mac OS X addressbook.

You can use this to sync contacts from FileMaker database to system addressbook. As your addressbook can be synchronized via iCloud to iPhones or via Google/Exchange to any other devices, you only need one Mac to sync contacts to devices.

On Server you can only use addressbook functions if you got a addressbook for the user account where the server runs. Normally the server user account has no addressbook.
For 32-bit and 64-bit Mac application.

See contacts functions for newer API which works better with multple accounts.

Item Details
Addressbook.Account.Name
Queries name of account.
Mac only
6.2
Addressbook.Account.Type
Queries type identifier for account.
Mac only
6.2
Addressbook.Account.URL
Queries base URL for account.
Mac only
6.2
Addressbook.Account.isMainAccount
Queries whether this is main account.
Mac only
6.2
Addressbook.LocalizedPropertyOrLabel
Queries a localized name for a label or property.
Mac only
3.5
Addressbook.NewGroup
Creates a new group.
Mac/iOS
3.1
Addressbook.NewPerson
Creates a new person.
Mac/iOS
3.1
Addressbook.Notification.Clear
Clears the registered notification script.
Mac only
3.5
Addressbook.Notification.Evaluate
Installs a notification evaluate.
Mac only
6.2
Addressbook.Notification.GetChangedExternally
Queries if the last notification script call was caused by a changed in another app.
Mac only
3.5
Addressbook.Notification.GetDeletedRecords
Queries list of deleted records.
Mac only
3.5
Addressbook.Notification.GetInsertedRecords
Queries list of inserted records.
Mac only
3.5
Addressbook.Notification.GetProcessID
Queries the process ID.
Mac only
3.5
Addressbook.Notification.GetProcessName
Queries the process name.
Mac only
3.5
Addressbook.Notification.GetUpdatedRecords
Queries list of updated records.
Mac only
3.5
Addressbook.Notification.GetUserUID
Queries the user ID.
Mac only
3.5
Addressbook.Notification.Set
Installs a notification script.
Mac only
3.5
Addressbook.Record.Account
Queries account identifier for record.
Mac only
6.2
Addressbook.addRecord
Adds an person or group record to the Address Book database.
Mac/iOS
3.1
Addressbook.allAccounts
Queries list of account identifies for all accounts.
Mac only
6.2
Addressbook.defaultAccount
Queries default account identifier.
Mac only
6.2
Addressbook.enabledAccounts
Queries list of account identifies for enabled accounts.
Mac only
6.2
Addressbook.formattedAddress
Returns an attributed string containing the formatted address.
Mac only
3.1
Addressbook.group.addMember
Adds a person to a group.
Mac/iOS
3.1
Addressbook.group.addSubgroup
Adds a subgroup to another group.
Mac/iOS
3.1
Addressbook.group.members
Returns an array of persons in a group.
Mac/iOS
3.1
Addressbook.group.parentGroups
Returns an array containing a group's parents—that is, the groups that a group belongs to.
Mac only
3.1
Addressbook.group.removeMember
Removes a person from a group.
Mac/iOS
3.1
Addressbook.group.removeSubgroup
Removes a subgroup from a group.
Mac/iOS
3.1
Addressbook.group.subgroups
Returns an array containing a group's subgroups.
Mac only
3.1
Addressbook.groups
Returns an array of all the groups in the Address Book database.
Mac/iOS
3.1
Addressbook.hasUnsavedChanges
Indicates whether an address book has changes that have not been saved to the Address Book database.
Mac/iOS
3.1
Addressbook.me
Returns the person record that represents the logged-in user.
Mac/iOS
3.1
Addressbook.multivalue.New
Creates a new multivalue object.
Mac/iOS
3.1
Addressbook.multivalue.addAddress
Adds an address and its label to a multivalue list.
Mac/iOS
5.1
Addressbook.multivalue.addValue
Adds a value and its label to a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.count
Returns the number of entries in a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.identifierAtIndex
Returns the identifier for the given index.
Mac/iOS
3.1
Addressbook.multivalue.identifiers
Returns the list of all identifiers.
Mac/iOS
6.1
Addressbook.multivalue.indexForIdentifier
Returns the index for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.indexForLabel
Returns the index for the given label.
Mac/iOS
8.2
Addressbook.multivalue.insertValue
Inserts a value and its label at the given index in a multivalue list.
Mac/iOS
3.1
Addressbook.multivalue.labelAtIndex
Returns the label for the given index.
Mac/iOS
3.1
Addressbook.multivalue.labelForIdentifier
Returns the label for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.labels
Returns the list of all labels.
Mac/iOS
6.1
Addressbook.multivalue.primaryIdentifier
Returns the identifier for the primary value.
Mac/iOS
3.1
Addressbook.multivalue.removeValueAndLabelAtIndex
Removes the value and label at the given index.
Mac/iOS
3.1
Addressbook.multivalue.replaceLabelAtIndex
Replaces the label at the given index.
Mac/iOS
3.1
Addressbook.multivalue.replaceValueAtIndex
Replaces the value at the given index.
Mac/iOS
3.1
Addressbook.multivalue.setPrimaryIdentifier
Sets the primary value to be the value for the given identifier.
Mac only
3.1
Addressbook.multivalue.valueAtIndex
Returns the value for the given index.
Mac/iOS
3.1
Addressbook.multivalue.valueForIdentifier
Returns the value for the given identifier.
Mac/iOS
3.1
Addressbook.multivalue.valueForLabel
Returns value for label.
Mac/iOS
6.1
Addressbook.multivalue.values
Returns the list of all values.
Mac/iOS
6.1
Addressbook.people
Returns an array of all the people in the Address Book database.
Mac/iOS
3.1
Addressbook.persistentAccounts
Queries list of account identifies for persistent accounts.
Mac only
6.2
Addressbook.person.EditInAddressbook
Launches Contacts application to edit this person.
Mac only
3.1
Addressbook.person.ExternalUID
Queries external UID for person.
Mac/iOS
6.1
Addressbook.person.GetImage
Returns data that contains a picture of this person.
Mac/iOS
3.1
Addressbook.person.SetBirthdayComponents
Sets the birthday data components.
Mac/iOS
5.4
Addressbook.person.SetImage
Sets the image for this person to the given image.
Mac/iOS
3.1
Addressbook.person.ShowInAddressbook
Launches Contacts application to show this person.
Mac only
3.1
Addressbook.person.linkedPeople
Returns the array of all person records that are linked to the person this record represents.
Mac/iOS
3.1
Addressbook.person.parentGroups
Returns an array of the address book groups that this person belongs to.
Mac only
3.1
Addressbook.person.vCardRepresentation
Returns the vCard representation of the person record as a data object in vCard format.
Mac/iOS
3.1
Addressbook.personFromVCardRepresentation
Creates an Person instance initialized with the given data.
Mac/iOS
3.1
Addressbook.personFromVCardTextRepresentation
Creates an Person instance initialized with the given text.
Mac/iOS
3.5
Addressbook.record.SetValueForProperty
Sets the value of a given property for a record.
Mac/iOS
3.1
Addressbook.record.UniqueID
Returns the unique ID for a record.
Mac/iOS
3.1
Addressbook.record.displayname
Convenience function to return a display name for a record.
Mac/iOS
3.1
Addressbook.record.isReadOnly
Returns whether a record is read-only.
Mac/iOS
3.1
Addressbook.record.removeValueForProperty
Removes the value for a given property.
Mac/iOS
3.1
Addressbook.record.valueForProperty
Returns the value of a given property for a record.
Mac/iOS
3.1
Addressbook.recordsMatchingSearchElement
Searches matching records.
Mac only
5.4
Addressbook.removeRecord
Removes an person or group record from the Address Book database.
Mac/iOS
3.1
Addressbook.save
Saves all the changes made since the last save.
Mac/iOS
3.1
Addressbook.searchElementForConjunction
Joins several search elements.
Mac only
5.4
Addressbook.searchElementForProperty
Creates a new search element.
Mac only
5.4
Addressbook.searchGroupsWithName
Searches groups matching the group name.
Mac only
3.3
Addressbook.searchPeopleWithCreationDate
Searches for people in address book with creation date between both dates.
Mac only
3.5
Addressbook.searchPeopleWithEmail
Searches all people with given email address.
Mac only
3.1
Addressbook.searchPeopleWithModificationDate
Searches for people in address book with modification date between both dates.
Mac only
3.5
Addressbook.searchPeopleWithName
Searches people matching the first and/or last name.
Mac only
3.1
Addressbook.searchPersonWithExternalUID
Searches addressbook for given external ID.
Mac only
6.1
Addressbook.setMe
Sets the record that represents the logged-in user.
Mac/iOS
3.1

85 functions.

Feedback: Report problem or ask question.




Links
MBS Xojo tutorial videos