Titanium.Contacts.Group
Extends Titanium.Proxy
An object which represents a group in the system contacts address book.
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 4
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Identifier of the group.
name
StringName of this group.
Methods 8
Adds a person to this group.
| Parameters | Type | Description |
|---|---|---|
| person | Titanium.Contacts.Person | Person to add. For >= iOS 9, it is not required to call Titanium.Contacts.save after calling this method. |
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Gets people that are members of this group.
Removes a person from this group. For >= iOS 9, it is not required to call Titanium.Contacts.save after calling this method.
| Parameters | Type | Description |
|---|---|---|
| person | Titanium.Contacts.Person | Person to remove. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
Gets people that are members of this group, sorted in the specified order.
| Parameters | Type | Description |
|---|---|---|
| sortBy | Number | Method for sorting. |