Class google.gdata.contacts.ContactQuery

Object
   |
   +--google.gdata.client.Query
         |
         +--google.gdata.contacts.ContactQuery

class google.gdata.contacts.ContactQuery

extends google.gdata.client.Query

Describes a query for the following feeds:

• The feed of contacts
• The feed of contact groups

Field Detail

ORDERBY_EDITED

<static> <final> {string} ORDERBY_EDITED

Order the returned feed's entries by their <app:edited> values.

See Also:

Constant Field Values

ORDERBY_LAST_MODIFIED

<static> <final> {string} ORDERBY_LAST_MODIFIED

Order the returned feed's entries by their <updated> values.

See Also:

Constant Field Values

ORDERBY_NONE

<static> <final> {string} ORDERBY_NONE

None.

See Also:

Constant Field Values

SORTORDER_ASCENDING

<static> <final> {string} SORTORDER_ASCENDING

Ascending.

See Also:

Constant Field Values

SORTORDER_DESCENDING

<static> <final> {string} SORTORDER_DESCENDING

Descending.

See Also:

Constant Field Values

SORTORDER_NONE

<static> <final> {string} SORTORDER_NONE

None.

See Also:

Constant Field Values

google.gdata.contacts.ContactQuery

google.gdata.contacts.ContactQuery(<string> feedUri)

Constructor.

Parameters:
feedUri - URI of feed.

getGroup

String? getGroup()

Returns the group id. Results are limited to contacts belonging to this group.

Returns:
Group id or null to indicate that the parameter is disabled.

getMaxResults

Number? getMaxResults()

Returns the maximum number of results to be retrieved.

Returns:
Maximum number of results to be retrieved or null to indicate that the parameter is disabled.

getOrderBy

String? getOrderBy()

Returns the order of entries in a feed.

Returns:
Order of entries in a feed or null to indicate that the parameter is disabled.

getShowDeleted

Boolean? getShowDeleted()

Returns the should tombstones be returned.

Returns:
Should tombstones be returned or null to indicate that the parameter is disabled.

getSortOrder

String? getSortOrder()

Returns the direction of sorting.

Returns:
Direction of sorting or null to indicate that the parameter is disabled.

getStartIndex

Number? getStartIndex()

Returns the 1-based index of the first result to be retrieved.

Returns:
1-based index of the first result to be retrieved or null to indicate that the parameter is disabled.

getUpdatedMax

google.gdata.DateTime? getUpdatedMax()

Returns the maximum updated date.

Returns:
Maximum updated date or null to indicate that the parameter is disabled.

getUpdatedMin

google.gdata.DateTime? getUpdatedMin()

Returns the minimum updated date.

Returns:
Minimum updated date or null to indicate that the parameter is disabled.

setGroup

void setGroup(<String?> group)

Sets the group id. Results are limited to contacts belonging to this group..

Parameters:
group - Group id or null to disable this parameter.

setMaxResults

void setMaxResults(<Number|string|null> maxResults)

Sets the maximum number of results to be retrieved.

Parameters:
maxResults - Maximum number of results to be retrieved or an equivalent string value or null to disable this parameter.

setOrderBy

void setOrderBy(<String?> orderBy)

Sets the order of entries in a feed. The default value is 'none'.

Parameters:
orderBy - Order of entries in a feed or null to disable this parameter.

setShowDeleted

void setShowDeleted(<Boolean|string|null> showDeleted)

Sets the should tombstones be returned. The default value is false.

Parameters:
showDeleted - Should tombstones be returned or an equivalent string value or null to disable this parameter.

setSortOrder

void setSortOrder(<String?> sortOrder)

Sets the direction of sorting. The default value is 'none'.

Parameters:
sortOrder - Direction of sorting or null to disable this parameter.

setStartIndex

void setStartIndex(<Number|string|null> startIndex)

Sets the 1-based index of the first result to be retrieved. The default value is 1.

Parameters:
startIndex - 1-based index of the first result to be retrieved or an equivalent string value or null to disable this parameter.

setUpdatedMax

void setUpdatedMax(<google.gdata.DateTime|string|null> updatedMax)

Sets the maximum updated date.

Parameters:
updatedMax - Maximum updated date or an equivalent string value or null to disable this parameter.

setUpdatedMin

void setUpdatedMin(<google.gdata.DateTime|string|null> updatedMin)

Sets the minimum updated date.

Parameters:
updatedMin - Minimum updated date or an equivalent string value or null to disable this parameter.