Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
CNContactStore.GroupHierarchy
Queries group hierarchy as JSON.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
Contacts | 8.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
Parameters
none
Result
Returns JSON or error.
Description
Queries group hierarchy as JSON.This is a convenience method to give you data for all groups with all subgroups and members in one call.
Examples
Query group hierarchie:
MBS("CNContactStore.GroupHierarchy")
Example result:
{
"62D07651-4F83-47D0-99F8-A72EAECBD8B7:ABGroup" : {
"subgroups" : [
"A0A7844B-1E8E-4ECF-8B81-273CB06B282D:ABGroup"
],
"contacts" : [
"4A2B7E15-BF77-416F-824E-0360FC4B196B:ABPerson",
"A0C31D4D-E573-432B-A8E4-016919E46A3A:ABPerson",
"1DC6166E-131E-449B-8BBC-DA689316D02A:ABPerson"
],
"identifier" : "62D07651-4F83-47D0-99F8-A72EAECBD8B7:ABGroup",
"name" : "Big Group"
},
"A0A7844B-1E8E-4ECF-8B81-273CB06B282D:ABGroup" : {
"parent" : "62D07651-4F83-47D0-99F8-A72EAECBD8B7:ABGroup",
"subgroups" : [
],
"contacts" : [
"4A2B7E15-BF77-416F-824E-0360FC4B196B:ABPerson",
"3495273B-715E-4258-9946-B0FC487211C5:ABPerson",
"773E1A42-ABCD-4CCF-88DE-E9C64BEE6D33:ABPerson",
"05DC9067-7FEE-4146-8CD9-6F88E7053307:ABPerson"
],
"identifier" : "A0A7844B-1E8E-4ECF-8B81-273CB06B282D:ABGroup",
"name" : "Test Group"
}
}
See also
Release notes
- Version 8.5
- Added CNContactStore.GroupHierarchy function.
Blog Entries
This function checks for a license.
Created 26th September 2018, last changed 26th September 2018
