Platforms to show: All Mac Windows Linux Cross-Platform

Back to ABAddressBookMBS class.

Next items

ABAddressBookMBS.ABAddressBookErrorDomain as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The error domain for Addressbook.

ABAddressBookMBS.ABMultiValueIdentifiersErrorKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the error keys for the addressbook.

ABAddressBookMBS.addressBook as ABAddressBookMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 12.5 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns a new instance of ABAddressBook, or nil if the Address Book database can't be initialized.

If you're just making one-off lookups and edits, the sharedAddressBook method is probably more appropriate.
If the user denies your application access to the Address Book database, this method returns nil.

Available in OS X v10.5 and later.
You need to use this method if you want to get an addressbook for ABPersonViewMBS.

ABAddressBookMBS.GotSharedAddressbook as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Whether some other part of your app queried the shared addressbook already.

sharedAddressbook asks for permissions the first time you call it.
So with this function you can check if some other application part already queried the sharedAddressbook function. If true, a call to sharedAddressbook should return quickly. Either with nil (no permissions) or the addressbook.

Some examples using this method:

ABAddressBookMBS.kABAddressCityKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the dictionary keys for the address.

Some examples using this method:

ABAddressBookMBS.kABAddressCountryCodeKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The Country Code of an address.

kABAddressCountryCodeKey code must be one of the following:
iso country codes

ae = United Arab Emirates
ar = Argentina
at = Austria
au = Australia
ba = Bosnia and Herzegovina
be = Belgium
bg = Bulgaria
bh = Bahrain
br = Brazil
ca = Canada
ch = Switzerland
cn = China
cs = Czech
de = Germany
dk = Denmark
eg = Egypt
es = Spain
fi = Finland
fr = France
gr = Greece
gl = Greenland
hk = Hong Kong
hr = Croatia
hu = Hungary
ie = Ireland
il = Israel
id = Indonesia
in = India
is = Iceland
it = Italy
ja = Japan
jo = Jordan
kr = South Korea
kw = Kuwait
lb = Lebanon
lu = Luxembourg
mk = Macedonia
mx = Mexico
nl = Netherlands
no = Norway
nz = New Zealand
om = Oman
pl = Poland
pt = Portugal
qa = Qatar
ro = Romania
ru = Russian Federation
sa = Saudi Arabia
se = Sweden
sg = Singapore
si = Slovenia
sk = Slovakia
sy = Syrian Arab Republic
tw = Taiwan
tr = Turkey
ua = Ukraine
uk = United Kingdom
us = United States
ye = Yemen
yu = Serbia and Montenegro
za = South Africa

Some examples using this method:

ABAddressBookMBS.kABAddressCountryKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the dictionary keys for the address.

kABAddressCountryCodeKey code must be one of the following:
iso country codes

ae= United Arab Emirates
ar= Argentina
at= Austria
au= Australia
ba= Bosnia and Herzegovina
be= Belgium
bg= Bulgaria
bh= Bahrain
br= Brazil
ca= Canada
ch= Switzerland
cn= China
cs= Czech
de= Germany
dk= Denmark
eg= Egypt
es= Spain
fi= Finland
fr= France
gr= Greece
gl= Greenland
hk= Hong Kong
hr= Croatia
hu= Hungary
ie= Ireland
il= Israel
id= Indonesia
in= India
is= Iceland
it= Italy
ja= Japan
jo= Jordan
kr= South Korea
kw= Kuwait
lb= Lebanon
lu= Luxembourg
mk= Macedonia
mx= Mexico
nl= Netherlands
no= Norway
nz= New Zealand
om= Oman
pl= Poland
pt= Portugal
qa= Qatar
ro= Romania
ru= Russian Federation
sa= Saudi Arabia
se= Sweden
sg= Singapore
si= Slovenia
sk= Slovakia
sy= Syrian Arab Republic
tw= Taiwan
tr= Turkey
ua= Ukraine
uk= United Kingdom
us= United States
ye= Yemen
yu= Serbia and Montenegro
za= South Africa

Some examples using this method:

ABAddressBookMBS.kABAddressHomeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the home address.

Some examples using this method:

ABAddressBookMBS.kABAddressProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Street Addresses - kABMultiDictionaryProperty

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABAddressStateKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the dictionary keys for the address.

Some examples using this method:

ABAddressBookMBS.kABAddressStreetKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the dictionary keys for the address.

Some examples using this method:

ABAddressBookMBS.kABAddressWorkLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the work address.

Some examples using this method:

ABAddressBookMBS.kABAddressZIPKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the dictionary keys for the address.

Some examples using this method:

ABAddressBookMBS.kABAIMHomeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the home AIM Instant Messaging account.

Some examples using this method:

ABAddressBookMBS.kABAIMInstantProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
AIM Instant Messaging - kABMultiStringProperty

This property is used for persons only.
Deprecated in Mac OS 10.7. You should use kABInstantMessageProperty.

Some examples using this method:

ABAddressBookMBS.kABAIMMobileMeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the multistring value for the kABAIMInstantProperty property.

Available on Mac OS X 10.7 or later.
none

ABAddressBookMBS.kABAIMWorkLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the work AIM Instant Messaging account.

Some examples using this method:

ABAddressBookMBS.kABAlternateBirthdayComponentsProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Alternate non-Gregorian birth date.

ABAddressBookMBS.kABAnniversaryLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The label for the anniversary date.

Some examples using this method:

ABAddressBookMBS.kABAssistantLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the related names.

Some examples using this method:

ABAddressBookMBS.kABBirthdayComponentsProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the property names for the addressbook records.

Available on Mac OS X 10.7 or later.
Birth date - kABDateComponentsProperty

ABAddressBookMBS.kABBirthdayProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Birth date - kABDateProperty

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABBrotherLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the related names.

Some examples using this method:

ABAddressBookMBS.kABCalendarURIsProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The calendars associated to a person.

Calendar URIs - kABMultiStringProperty

Some examples using this method:

ABAddressBookMBS.kABChildLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the related names.

Some examples using this method:

ABAddressBookMBS.kABCreationDateProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Creation Date (when first saved) - kABDateProperty

A property for all records.

Some examples using this method:

ABAddressBookMBS.kABDatabaseChangedExternallyNotification as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The notification name to use with NSNotificationObserverMBS class.

Posted when a process other than the current one has changed the Address Book database.
Depending on the operation performed on the address book, one or more of the following keys may be included in the user-info dictionary: kABInsertedRecords, kABUpdatedRecords, and kABDeletedRecords. The values for each of the keys are the unique IDs of the records that were inserted, updated, or deleted, respectively. If the values for all the keys are nil, every record has changes. For example, this happens when the Address Book database is restored from a backup copy.

The plugin implements this notification for you and calls the DatabaseChanged event in ABAddressBookMBS class.

ABAddressBookMBS.kABDatabaseChangedNotification as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The notification name to use with NSNotificationObserverMBS class.

Posted when this process has changed the Address Book database.
Depending on the operation performed on the address book, one or more of the following keys may be included in the user-info dictionary: kABInsertedRecords, kABUpdatedRecords, and kABDeletedRecords. The values for each of the keys are the unique IDs of the records that were inserted, updated, or deleted, respectively. If the values for all the keys are nil, every record has changes. For example, this happens when the Address Book database is restored from a backup copy.

The plugin implements this notification for you and calls the DatabaseChanged event in ABAddressBookMBS class.

ABAddressBookMBS.kABDeletedRecords as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the keys contained by the user-info dictionary of the notifications posted by the Address Book framework.

Records that have been deleted.

ABAddressBookMBS.kABDepartmentProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Department name - (Person)

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABEmailHomeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the home email address.

Some examples using this method:

ABAddressBookMBS.kABEmailMobileMeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for emails.

Available on Mac OS X 10.7 or later.
MobileMe email

ABAddressBookMBS.kABEmailProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Email(s) - kABMultiStringProperty

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABEmailWorkLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the work email address.

Some examples using this method:

ABAddressBookMBS.kABFatherLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the related names.

Some examples using this method:

ABAddressBookMBS.kABFirstNamePhoneticProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
First name Phonetic - kABStringProperty

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABFirstNameProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
First name - kABStringProperty
Example 
dim a as new ABAddressBookMBS
dim p as new ABPersonMBS

if not p.setValue("Ben",a.kABFirstNameProperty) then
  MsgBox "Failed to set field "+a.LocalizedPropertyOrLabel(a.kABFirstNameProperty)
end if

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABFriendLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the labels for the related names.

Some examples using this method:

ABAddressBookMBS.kABGroupNameProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Name of the group - kABStringProperty
Example 
dim theAB as new ABAddressBookMBS
dim result as new ABGroupMBS
dim error as NSErrorMBS
dim b as Boolean=result.SetValue("test",TheAB.kABGroupNameProperty,error)
if not b then
  Msgbox("Failed to name group test."+error.description)
else
  MsgBox "OK"
end if

This property is used for groups only.

Some examples using this method:

ABAddressBookMBS.kABHomeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A generic label.

All kABXXXXHomeLabel are equivalent to this label.

Some examples using this method:

ABAddressBookMBS.kABHomePageLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Homepage URL label for the kABURLsProperty.

Some examples using this method:

ABAddressBookMBS.kABHomePageProperty as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Home Web page - kABStringProperty

This property is used for persons only.
Deprecated in Mac OS 10.4. You should use kABURLsProperty.

Some examples using this method:

ABAddressBookMBS.kABICQHomeLabel as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A label for the home ICQ Instant Messaging account.

Some examples using this method:

Next items

The items on this page are in the following plugins: MBS MacCocoa Plugin.


The biggest plugin in space...