me.adaptive.arp.api

Class ContactBridge

java.lang.Object

me.adaptive.arp.api.BasePIMBridge

me.adaptive.arp.api.ContactBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBasePIM, IContact

public class ContactBridge
extends BasePIMBridge
implements IContact, APIBridge

Interface for Managing the Contact operations Auto-generated implementation of IContact specification.

Field Summary

Fields inherited from class me.adaptive.arp.api.BasePIMBridge

apiGroup

Constructor Summary

Constructors

Constructor and Description
ContactBridge(IContact delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
void	getContact(ContactUid contact, IContactResultCallback callback) Get all the details of a contact according to its id
void	getContactPhoto(ContactUid contact, IContactPhotoResultCallback callback) Get the contact photo
void	getContacts(IContactResultCallback callback) Get all contacts
void	getContactsForFields(IContactResultCallback callback, IContactFieldGroup[] fields) Get marked fields of all contacts
void	getContactsWithFilter(IContactResultCallback callback, IContactFieldGroup[] fields, IContactFilter[] filter) Get marked fields of all contacts according to a filter
IContact	getDelegate() Get the delegate implementation.
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
void	searchContacts(java.lang.String term, IContactResultCallback callback) Search contacts according to a term and send it to the callback
void	searchContactsWithFilter(java.lang.String term, IContactResultCallback callback, IContactFilter[] filter) Search contacts according to a term with a filter and send it to the callback
boolean	setContactPhoto(ContactUid contact, byte[] pngImage) Set the contact photo
void	setDelegate(IContact delegate) Set the delegate implementation.

Methods inherited from class me.adaptive.arp.api.BasePIMBridge

getAPIGroup, getAPIVersion, getJSONParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Constructor Detail

ContactBridge

public ContactBridge(IContact delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final IContact getDelegate()

Get the delegate implementation.

Returns:

IContact delegate that manages platform specific functions..

setDelegate

public final void setDelegate(IContact delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

getContact

public void getContact(ContactUid contact,
                       IContactResultCallback callback)

Get all the details of a contact according to its id

Specified by:

getContact in interface IContact

Parameters:

contact - id to search for

callback - called for return

Since:

v2.0

getContactPhoto

public void getContactPhoto(ContactUid contact,
                            IContactPhotoResultCallback callback)

Get the contact photo

Specified by:

getContactPhoto in interface IContact

Parameters:

contact - id to search for

callback - called for return

Since:

v2.0

getContacts

public void getContacts(IContactResultCallback callback)

Get all contacts

Specified by:

getContacts in interface IContact

Parameters:

callback - called for return

Since:

v2.0

getContactsForFields

public void getContactsForFields(IContactResultCallback callback,
                                 IContactFieldGroup[] fields)

Get marked fields of all contacts

Specified by:

getContactsForFields in interface IContact

Parameters:

callback - called for return

fields - to get for each Contact

Since:

v2.0

getContactsWithFilter

public void getContactsWithFilter(IContactResultCallback callback,
                                  IContactFieldGroup[] fields,
                                  IContactFilter[] filter)

Get marked fields of all contacts according to a filter

Specified by:

getContactsWithFilter in interface IContact

Parameters:

callback - called for return

fields - to get for each Contact

filter - to search for

Since:

v2.0

searchContacts

public void searchContacts(java.lang.String term,
                           IContactResultCallback callback)

Search contacts according to a term and send it to the callback

Specified by:

searchContacts in interface IContact

Parameters:

term - string to search

callback - called for return

Since:

v2.0

searchContactsWithFilter

public void searchContactsWithFilter(java.lang.String term,
                                     IContactResultCallback callback,
                                     IContactFilter[] filter)

Search contacts according to a term with a filter and send it to the callback

Specified by:

searchContactsWithFilter in interface IContact

Parameters:

term - string to search

callback - called for return

filter - to search for

Since:

v2.0

setContactPhoto

public boolean setContactPhoto(ContactUid contact,
                               byte[] pngImage)

Set the contact photo

Specified by:

setContactPhoto in interface IContact

Parameters:

contact - id to assign the photo

pngImage - photo as byte array

Returns:

true if set is successful;false otherwise

Since:

v2.0

invoke

public APIResponse invoke(APIRequest request)

Invokes the given method specified in the API request object.

Specified by:

invoke in interface APIBridge

Overrides:

invoke in class BasePIMBridge

Parameters:

request - APIRequest object containing method name and parameters.

Returns:

APIResponse with status code, message and JSON response or a JSON null string for void functions. Status code 200 is OK, all others are HTTP standard error conditions.