Platforms to show: All Mac Windows Linux Cross-Platform
Back to ABAddressBookMBS class.
ABAddressBookMBS.accountWithIdentifier(Identifier as string) as ABAccountMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ABAddressBookMBS.addRecord(record as ABRecordMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if the addition was successful
See also:
ABAddressBookMBS.addRecord(record as ABRecordMBS, Account as ABAccountMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if the addition was successful.
On Mac OS X 10.7 the error parameter is set to describe the error.
See also:
ABAddressBookMBS.addRecord(record as ABRecordMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if the addition was successful.
On Mac OS X 10.7 the error parameter is set to describe the error.
See also:
ABAddressBookMBS.allAccounts as ABAccountMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Some examples using this method:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 13.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ABAddressBookMBS.enabledAccounts as ABAccountMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 12.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
You only need to call this if you use AddHandler command in Xojo to add event handlers. The plugin automatically does that in the constructor, but that is too early for AddHandler. And plugin on enables events if you use them.
ABAddressBookMBS.formattedAddressFromDictionary(address as Dictionary) as NSAttributedStringMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The string's attributes match address dictionary keys (kABAddressStreetKey for example).
Each attribute value contains the localized description of the key. (For example, the value of a Canadian kABAddressZIPKey field would be Postal Code)
Some examples using this method:
ABAddressBookMBS.groupForName(name as string) as ABGroupMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 12.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ABAddressBookMBS.groupForUniqueId(uniqueid as string) as ABGroupMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil if the record could not be found or matches to a person.
Available in Mac OS X 10.3 or newer.
see also recordForUniqueId.
See also:
ABAddressBookMBS.groupForUniqueId(uniqueid as string, account as ABAccountMBS) as ABGroupMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
ABAddressBookMBS.groups as ABGroupMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns an empty array in case the DB doesn't contain any groups.
Returns nil on any error.
Some examples using this method:
ABAddressBookMBS.groupsForAccount(account as ABAccountMBS) as ABGroupMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns an empty array in case the DB doesn't contain any body.
Some examples using this method:
ABAddressBookMBS.LocalizedPropertyOrLabel(propertyOrLabel as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns propertyOrLabel if not found (e.g. if not built in).
Some examples using this method:
ABAddressBookMBS.NewPersonWithVCardRepresentation(data as memoryblock) as ABPersonMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil on failure.
Convenience function which cen be used instead of the ABPersonMBS constructor.
ABAddressBookMBS.people as ABPersonMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns an empty array in case the DB doesn't contain any body.
Returns nil on any error.
Some examples using this method:
ABAddressBookMBS.peopleForAccount(account as ABAccountMBS) as ABPersonMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns an empty array in case the DB doesn't contain any body.
ABAddressBookMBS.peopleForEmail(email as string) as ABPersonMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 12.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ABAddressBookMBS.persistentAccounts as ABAccountMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ABAddressBookMBS.personForUniqueId(uniqueid as string) as ABPersonMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil if the record could not be found or matches to a group.
Available in Mac OS X 10.3 or newer.
see also recordForUniqueId.
See also:
ABAddressBookMBS.personForUniqueId(uniqueid as string, account as ABAccountMBS) as ABPersonMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
ABAddressBookMBS.recordClassFromUniqueId(uniqueid as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Return "ABPersonMBS" or "ABGroup" or "" for a given uniqueid.
ABAddressBookMBS.recordForUniqueId(uniqueid as string) as ABRecordMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil if the record could not be found.
Available in Mac OS X 10.3 or newer.
See also:
Some examples using this method:
ABAddressBookMBS.recordForUniqueId(uniqueid as string, account as ABAccountMBS) as ABRecordMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 15.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
ABAddressBookMBS.recordsMatchingSearchElement(search as ABSearchElementMBS) as ABRecordMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns an empty array if no matches or an error.
Some examples using this method:
ABAddressBookMBS.removeRecord(record as ABRecordMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if the removal was successful.
See also:
ABAddressBookMBS.removeRecord(record as ABRecordMBS, byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 11.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns true if the removal was successful.
On Mac OS X 10.7 the error parameter is set to describe the error.
See also:
ABAddressBookMBS.save as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Return true if successful (or there was no change).
See also:
ABAddressBookMBS.save(byref error as NSErrorMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.7 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Return true if successful (or there was no change).
On Mac OS X 10.5 the error object is returned. On Mac OS X 10.4 this error property is nil and you only can use the result.
See also:
ABAddressBookMBS.setMe(moi as ABPersonMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Addressbook | MBS MacCocoa Plugin | 7.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Pass nil to clear "Me".
The items on this page are in the following plugins: MBS MacCocoa Plugin.