# Titanium.Contacts.Group

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

- Source: https://titaniumsdk.com/docs/sdk/12.5.0/Titanium.Contacts.Group
- Titanium SDK version: 12.5.0
- Kind: proxy
- Platforms: iPhone, iPad, macOS
- Since: Titanium SDK iPhone 1.4.0, iPad 1.4.0, macOS 9.2.0
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

See examples in [Titanium.Contacts](https://titaniumsdk.com/docs/sdk/Titanium.Contacts.md) for more information.

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

## Properties

### identifier

- Type: String
- Platforms: iPhone, iPad, macOS
- Permission: read-only

Identifier of the group.

### name

- Type: String
- Platforms: iPhone, iPad, macOS

Name of this group.

## Methods

### add

- Platforms: iPhone, iPad, macOS

Adds a person to this group.

Parameters:

- `person` (Titanium.Contacts.Person): Person to add. For >= iOS9, it is not required to call [Titanium.Contacts.save](https://titaniumsdk.com/docs/sdk/Titanium.Contacts.md#save) after calling this method.

### members

- Platforms: iPhone, iPad, macOS

Gets people that are members of this group.

Returns: Array<Titanium.Contacts.Person>

### remove

- Platforms: iPhone, iPad, macOS

Removes a person from this group. For >= iOS9, it is not
required to call [Titanium.Contacts.save](https://titaniumsdk.com/docs/sdk/Titanium.Contacts.md#save) after calling this method.

Parameters:

- `person` (Titanium.Contacts.Person): Person to remove.

### sortedMembers

- Platforms: iPhone, iPad, macOS

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

Parameters:

- `sortBy` (Number): Method for sorting.

Returns: Array<Titanium.Contacts.Person>

## Inherited members

6 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/12.5.0/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.

