com.podio.contact

Class ContactAPI

java.lang.Object

com.podio.BaseAPI

com.podio.contact.ContactAPI

public class ContactAPI
extends BaseAPI

Each user have a profile attached, that holds all the personal details of the user. This includes very basic information like the name and mail addresses, but can also include more advanced fields like billing address and IM addresses. Fields can have either one or multiple values. There can f.ex. only be one name, but multiple mail addresses. The value of a field can either be a string, a number or a date.

Constructor Summary

Constructors

Constructor and Description
ContactAPI(ResourceFactory resourceFactory)

Method Summary

Methods

Modifier and Type	Method and Description
Profile	getContact(int userId) Returns all the contact details about the user with the given id.
<T,R> List<T>	getContactField(int userId, ProfileField<T,R> field) Returns the value of a contact with the specific field
<T,F,R> List<T>	getContacts(ProfileField<F,R> key, F value, Integer limit, Integer offset, ProfileType<T> type, ContactOrder order) Used to get a list of contacts for the user.
ContactTotal	getContactTotal() Returns the total number of contacts by organization.
<T,F,R> List<T>	getOrganizationContacts(int organizationId, ProfileField<F,R> key, F value, Integer limit, Integer offset, ProfileType<T> type, ContactOrder order) Returns all the profiles of the users contacts on the given organization
<T,F,R> List<T>	getSpaceContacts(int spaceId, ProfileField<F,R> key, F value, Integer limit, Integer offset, ProfileType<T> type, ContactOrder order) Returns all the profiles of the users contacts on the given space

Methods inherited from class com.podio.BaseAPI

getResourceFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactAPI

public ContactAPI(ResourceFactory resourceFactory)

Method Detail

getContact

public Profile getContact(int userId)

Returns all the contact details about the user with the given id.

Parameters:

userId - The id of the user

Returns:

The contact profile

getContactField

public <T,R> List<T> getContactField(int userId,
                            ProfileField<T,R> field)

Returns the value of a contact with the specific field

Parameters:

userId - The id of the user

field - The field for which data should be returned

Returns:

The list of values for the given field

getContactTotal

public ContactTotal getContactTotal()

Returns the total number of contacts by organization.

Returns:

The list of contact totals by organization

getContacts

public <T,F,R> List<T> getContacts(ProfileField<F,R> key,
                          F value,
                          Integer limit,
                          Integer offset,
                          ProfileType<T> type,
                          ContactOrder order)

Used to get a list of contacts for the user.

Parameters:

key - The profile field if the contacts should be filtered

value - The value for the field if the contacts should be filtered

limit - The maximum number of contacts to return

offset - The offset into the list of contacts

type - The format in which the contacts should be returned

order - How the contacts should be ordered

Returns:

The list of contacts

getOrganizationContacts

public <T,F,R> List<T> getOrganizationContacts(int organizationId,
                                      ProfileField<F,R> key,
                                      F value,
                                      Integer limit,
                                      Integer offset,
                                      ProfileType<T> type,
                                      ContactOrder order)

Returns all the profiles of the users contacts on the given organization

Parameters:

organizationId - The id of the organization the contacts should be returned from

key - The profile field if the contacts should be filtered

value - The value for the field if the contacts should be filtered

limit - The maximum number of contacts to return

offset - The offset into the list of contacts

type - The format in which the contacts should be returned

order - How the contacts should be ordered

Returns:

The list of contacts

getSpaceContacts

public <T,F,R> List<T> getSpaceContacts(int spaceId,
                               ProfileField<F,R> key,
                               F value,
                               Integer limit,
                               Integer offset,
                               ProfileType<T> type,
                               ContactOrder order)

Returns all the profiles of the users contacts on the given space

Parameters:

spaceId - The id of the space the contacts should be returned from

key - The profile field if the contacts should be filtered

value - The value for the field if the contacts should be filtered

limit - The maximum number of contacts to return

offset - The offset into the list of contacts

type - The format in which the contacts should be returned

order - How the contacts should be ordered

Returns:

The list of contacts