Titanium SDK # Titanium.Contacts.Group
An object which represents a group in the system contacts address book.
1.4.0
9.2.0# 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
# apiName READONLY
3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
3.0.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# Methods
# add
1.4.0 9.2.0Adds 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
# addEventListener
1.4.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.0.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
1.4.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# members
1.4.0 9.2.0Gets people that are members of this group.
Returns
- Type
- Array<Titanium.Contacts.Person>
# remove
1.4.0 9.2.0Removes 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
# removeEventListener
1.4.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# sortedMembers
1.4.0 9.2.0Gets 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>