# Titanium.Contacts.Group

An object which represents a group in the system contacts address book.

Availability

1.4.0

9.2.0

Extends

Titanium.Proxy

# Overview

See examples in Titanium.Contacts for more information.

These APIs are unavailable on macOS if the app is built on a version of Xcode < 12.

# Properties

# identifier READONLY

Availability

1.4.0

9.2.0

identifier :String

Identifier of the group.

# name

Availability

1.4.0

9.2.0

name :String

Name of this group.

# recordId

Availability

1.4.0

9.2.0

recordId :Number

Record identifier of the group. Single value. Deprecated for iOS 9 and later.

# Methods

# add

Availability

1.4.0

9.2.0

add(person) → void

Adds a person to this group.

Parameters

Name	Type	Description
`person`	Titanium.Contacts.Person	Person to add. For >= iOS9, it is not required to call save after calling this method.

Returns

Type: void

# members

Availability

1.4.0

9.2.0

members() → Array<Titanium.Contacts.Person>

Gets people that are members of this group.

Returns

Type: Array<Titanium.Contacts.Person>

# remove

Availability

1.4.0

9.2.0

remove(person) → void

Removes a person from this group. For >= iOS9, it is not required to call save after calling this method.

Parameters

Name	Type	Description
`person`	Titanium.Contacts.Person	Person to remove.

Returns

Type: void

# sortedMembers

Availability

1.4.0

9.2.0

sortedMembers(sortBy) → Array<Titanium.Contacts.Person>

Gets people that are members of this group, sorted in the specified order.

Parameters

Name	Type	Description
`sortBy`	Number	Method for sorting.

Returns

Type: Array<Titanium.Contacts.Person>