Titanium.Contacts.Group
> Titanium.Contacts.Group

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

See examples in Titanium.Contacts for more information.

  • 1.4.0
  • 1.4.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates 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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium.Contacts.Group
: Stringreadonly
Identifier of the group. ...

Identifier of the group.

Requires: iOS 9.0 and later

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Titanium.Contacts.Group
name : String

Name of this group.

Name of this group.

Titanium.Contacts.Group
: Number
Record identifier of the group. ...

Record identifier of the group. Single value. Deprecated for >= iOS9.

Requires: iOS 8.0 and earlier

Defined By

Methods

Titanium.Contacts.Group
( person )
Adds a person to this group. ...

Adds a person to this group.

Parameters

Returns

  • void
Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

Applies 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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium.Contacts.Group
( ) : String
Gets the value of the identifier property. ...

Gets the value of the identifier property.

Returns

  • String
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Contacts.Group
( ) : String
Gets the value of the name property. ...

Gets the value of the name property.

Returns

  • String
Titanium.Contacts.Group
( ) : Number
Gets the value of the recordId property. ...

Gets the value of the recordId property.

Returns

  • Number
Titanium.Contacts.Group
( ) : Titanium.Contacts.Person[]
Gets people that are members of this group. ...

Gets people that are members of this group.

Returns

Titanium.Contacts.Group
( person )
Removes a person from this group. ...

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

Parameters

Returns

  • void
Removes the specified callback as an event listener for the named event. ...

Removes 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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Contacts.Group
( name )
Sets the value of the name property. ...

Sets the value of the name property.

Parameters

  • name : String

    New value for the property.

Returns

  • void
Titanium.Contacts.Group
( recordId )
Sets the value of the recordId property. ...

Sets the value of the recordId property.

Parameters

  • recordId : Number

    New value for the property.

Returns

  • void
Titanium.Contacts.Group
( sortBy ) : Titanium.Contacts.Person[]
Gets people that are members of this group, sorted in the specified order. ...

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

Parameters

Returns