Platforms to show: All Mac Windows Linux Cross-Platform

Back to ABAddressBookMBS class.

Previous items

ABAddressBookMBS.kABRelatedNamesProperty 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
names related to this person - kABMultiStringProperty

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABSisterLabel 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.kABSocialProfileProperty 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
Social Profiles - kABMultiDictionaryProperty

Available on Mac OS X 10.7 or later.
The multi dictionary contains dictionaries. Each has keys like kABSocialProfileURLKey, kABSocialProfileUsernameKey, kABSocialProfileUserIdentifierKey and kABSocialProfileServiceKey.

kABSocialProfileServiceKey has values like kABSocialProfileServiceTwitter, kABSocialProfileServiceFacebook, kABSocialProfileServiceLinkedIn, kABSocialProfileServiceFlickr and kABSocialProfileServiceMySpace.

ABAddressBookMBS.kABSocialProfileServiceFacebook 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 values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.7 or later.
Facebook

ABAddressBookMBS.kABSocialProfileServiceFlickr 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 values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.7 or later.
Flickr

ABAddressBookMBS.kABSocialProfileServiceKey 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 for addressbook record values.

Available on Mac OS X 10.7 or later.
The service for this social profile. Can be kABSocialProfileServiceTwitter, kABSocialProfileServiceFacebook, kABSocialProfileServiceLinkedIn, kABSocialProfileServiceFlickr or kABSocialProfileServiceMySpace.

ABAddressBookMBS.kABSocialProfileServiceLinkedIn 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 values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.7 or later.
LinkedIn

ABAddressBookMBS.kABSocialProfileServiceMySpace 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 values for the social profile dictionary's kABSocialProfileServiceKey key.

MySpace
Available on Mac OS X 10.7 or later.

ABAddressBookMBS.kABSocialProfileServiceSinaWeibo as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the values for the social profile dictionary's kABSocialProfileServiceKey key.

SinaWeibo
Available in Mac OS X 10.8 and newer.

ABAddressBookMBS.kABSocialProfileServiceTencentWeibo as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop only
One of the values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.9 or later.
Tencent Weibo

ABAddressBookMBS.kABSocialProfileServiceTwitter 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 values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.7 or later.
Twitter

ABAddressBookMBS.kABSocialProfileServiceYelp 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
One of the values for the social profile dictionary's kABSocialProfileServiceKey key.

Available on Mac OS X 10.7 or later.
Yelp

ABAddressBookMBS.kABSocialProfileURLKey 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 for addressbook record values.

Available on Mac OS X 10.7 or later.
Service name. Possible values follow.

ABAddressBookMBS.kABSocialProfileUserIdentifierKey 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 for addressbook record values.

Available on Mac OS X 10.7 or later.
Service-specific identifier.

ABAddressBookMBS.kABSocialProfileUsernameKey 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 for addressbook record values.

Available on Mac OS X 10.7 or later.
User-visible profile name.

ABAddressBookMBS.kABSpouseLabel 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.kABSuffixProperty 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 name suffix - kABStringProperty

e.g. "Sr." "Jr." "III"
This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABTitleProperty 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 title of the person - kABStringProperty

e.g. "Sir" "Duke" "General" "Lord"
This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABUIDProperty 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 UID property - kABStringProperty

A property for all records.

Some examples using this method:

ABAddressBookMBS.kABUpdatedRecords 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 updated.

ABAddressBookMBS.kABURLsProperty 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
URLs - kABMultiStringProperty
Example
// shows all websites with labels

dim a as new ABAddressBookMBS
dim p as ABPersonMBS = a.owner
dim m as ABMultiValueMBS = p.valueForProperty(a.kABURLsProperty)

dim u as Integer = m.count-1
for i as Integer = 0 to u
dim label as string = m.labelAtIndex(i)
dim value as string = m.valueAtIndex(i)

MsgBox label+" -> "+value
next

This property is used for persons only.

Some examples using this method:

ABAddressBookMBS.kABWorkLabel 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 kABXXXXWorkLabel are equivalent to this label

Some examples using this method:

ABAddressBookMBS.kABYahooHomeLabel 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 yahoo Instant Messaging account.

Some examples using this method:

ABAddressBookMBS.kABYahooInstantProperty 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
Yahoo 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.kABYahooWorkLabel 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 yahoo Instant Messaging account.

Some examples using this method:

ABAddressBookMBS.searchElementForConjunction(conjunction as Integer, children() as ABSearchElementMBS) as ABSearchElementMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Creates a search element combining several sub search elements.

Convenience function which can be used instead of ABSearchElementMBS.searchElementForConjunction.

ABAddressBookMBS.searchElementForGroupProperty(PropertyName as string, Label as string, Key as string, value as Variant, comparison as Integer) as ABSearchElementMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns a search element that will search groups.

Convenience function to be used instead of the searchElementForProperty method in the ABGroupMBS class.

ABAddressBookMBS.searchElementForPersonProperty(PropertyName as string, Label as string, Key as string, value as Variant, comparison as Integer) as ABSearchElementMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns a search element that will search people.
Example
// search person by record's unique ID
// this is same as calling recordForUniqueId function directly
dim a as new ABAddressBookMBS
dim e as ABSearchElementMBS

dim PropertyName as string = a.kABUIDProperty
const Label = ""
const Key = ""
const value = "637FA922-7A2B-4F9A-BFA3-023253D4A3D5:ABPerson" // some person ID
const comparison = a.kABEqual

e = ABPersonMBS.searchElementForProperty(PropertyName, label, key, value, comparison)

dim records() as ABRecordMBS = a.recordsMatchingSearchElement(e)

for each r as ABRecordMBS in records
dim p as ABPersonMBS = ABPersonMBS(r)

MsgBox p.DisplayName
next

Convenience function to be used instead of the searchElementForProperty method in the ABPersonMBS class.

Some examples using this method:

ABAddressBookMBS.sharedAddressbook as ABAddressBookMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 12.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the shared addressbook object.
Example
// quickly find the addressbook, locate me and display my name:
MsgBox ABAddressBookMBS.sharedAddressbook.owner.DisplayName

If you call this method several times, the object is cached, so it's only created the first time (singleton).
Returns nil on Windows or Linux or low memory or missing permissions.

Some examples using this method:

ABAddressBookMBS.sharedAddressbookMT as ABAddressBookMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Addressbook MBS MacCocoa Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the shared addressbook object.

On Mac OS X 10.8, the user will be asked to allow access to the addressbook for your application. As the call to sharedAddressbook blocks in this case, this method can be called on a thread to avoid the blocking of your app.

If you call this method several times, the object is cached, so it's only created the first time (singleton).
Returns nil on Windows or Linux or low memory or missing permissions.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

Some examples using this method:

Previous items

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


The biggest plugin in space...