CNContactStore.Groups

Queries list of all groups.

Parameters

none

Result

Returns list or error.

Description

Examples

Show groups with IDs and names in field:

Set Variable [ $groups ; Value: MBS( "CNContactStore.Groups" ) ]
Set Variable [ $count ; Value: ValueCount ( $groups ) ]
If [ $count > 0 ]
    Set Variable [ $index ; Value: 1 ]
    Set Variable [ $text ; Value: "" ]
    Loop
        #
        Set Variable [ $groupID ; Value: GetValue($groups; $index) ]
        Set Variable [ $groupName ; Value: MBS( "CNGroup.Name"; $groupID ) ]
        Set Variable [ $text ; Value: $text & $GroupName & " " & $groupID ]
        #
        # next
        Set Variable [ $index ; Value: $index + 1 ]
        Exit Loop If [ $index > $count ]
        Set Variable [ $text ; Value: $text & ¶ ]
    End Loop
End If
Set Field [ Contacts::Result ; $text ]

Queries group names:

While(
[
    names = "";
    // query list of group IDs
    list = MBS( "CNContactStore.Groups" );
    count = ValueCount(list);
    index = 1
] ;
    index ≤ count ;
[
    id = GetValue(list; index);
    // query name for each ID
    name = MBS( "CNGroup.Name"; id);
    names = names & id & " -> " & name & ¶;
    index = index + 1
] ;
// return all the names
names )

See also

• CNContactStore.AddGroup
• CNContactStore.Country
• CNContactStore.GroupsByName
• CNContactStore.GroupsForContact
• CNContactStore.RequestAccesss
• CNContactStore.Subgroups
• CNGroup.Name

Example Databases

• Mac and iOS/Contacts/Contacts Dialogs
• Mac and iOS/Contacts/Contacts

This function checks for a license.

Created 1st August 2018, last changed 14th June 2022

CNContactStore.GroupHierarchy - CNContactStore.GroupsByName