com.licorize.api.client
Interface LicorizeClient

All Superinterfaces:

LicorizeAuthenticationClient

All Known Implementing Classes:

LicorizeClientImpl

public interface LicorizeClient
extends LicorizeAuthenticationClient

Author:

Federico Soldani - fsoldani@open-lab.com

Method Summary

LicorizeApiResponse	changeStripType(int stripId, java.lang.String stripType) Change a strip type.
LicorizeApiResponse	createProject(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Create project
LicorizeApiResponse	createStrip(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Create single strip
LicorizeApiResponse	getProject(int projectId) Return the project identified by the specified ID.
LicorizeApiResponse	getProjectMembers(int projectId) Return the project members list.
LicorizeApiResponse	getProjectsList() Return the projects list for the current user.
LicorizeApiResponse	getPublicUser(java.lang.String userName) Get user public data from userName.
LicorizeApiResponse	getStrip(int stripId) Returns the strip identified by the specified ID.
LicorizeApiResponse	getStripList() Returns strips from time line in descending order
LicorizeApiResponse	getStripList(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Returns the last strips from the user time line
LicorizeApiResponse	getTagsList() Show the complete tag cloud.
LicorizeApiResponse	getUser() Get the current user.
LicorizeApiResponse	remindMeLater(java.lang.String url) Method for saving a new remind me later strip.
LicorizeApiResponse	remindMeLater(java.lang.String url, java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Method for save a new remind me later strip.
LicorizeApiResponse	removeProject(int projectId) Remove single project identified by the specified ID.
LicorizeApiResponse	removeStrip(int stripId) Remove the strip identified by the specified ID.
LicorizeApiResponse	updateProject(int projectId, java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Update project.
LicorizeApiResponse	updateStrip(int stripId, java.util.List<Parameter<java.lang.String,java.lang.String>> parameters) Update single strip

Methods inherited from interface com.licorize.api.client.LicorizeAuthenticationClient

getAccessToken, getAuthenticationUrl, getRequestToken, setAccessToken

Method Detail

getStripList

LicorizeApiResponse getStripList()

Returns strips from time line in descending order

Returns:

strips list

getStripList

LicorizeApiResponse getStripList(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Returns the last strips from the user time line

Parameters:

parameters: - filtering parameters Optional: type - Strip type e.g. 'BOOKMARK' types - Strips type list comma separated team - Project Id user - User Id - If not specified it's the current user searchText - Text filter tags - Tag list comma separated millis - timeline millis (see lastMillis on the response) limitResultTo - number of results - default is 10

Returns:

strip list more - true if there are more strips in result list totStrips - the whole number of matching strips lastMillis - the oldest timeStamp in the response (used in next call if more is true on "millis" parameter) strips - strip list tags - an array of tags used by matching strips

getStrip

LicorizeApiResponse getStrip(int stripId)

Returns the strip identified by the specified ID.

Parameters:

stripId -

Returns:

strip

updateStrip

LicorizeApiResponse updateStrip(int stripId,
                                java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Update single strip

Parameters:

stripId -

parameters - Optional: type - Strip Type e.g. 'BOOKMARK' teamId - Project Id notes - Strip Notes ownerId - User Id title - Strip title url - Strip url email - Strip email tags - Strip tags (comma separated list) sticky - Is Sticky Strip - ('yes' - 'no') worklogDone - total worklog done dueDate - Strip due date time - if present 'dueDate' - for instance "REMAINDER" done - ('yes' - 'no') - Strip done

Returns:

strip updated

createStrip

LicorizeApiResponse createStrip(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Create single strip

Parameters:

parameters - Optional: type - Strip Type e.g. 'BOOKMARK' teamId - Project Id notes - Strip Notes ownerId - User Id title - Strip title url - Strip url email - Strip email tags - Strip tags (comma separated list) sticky - Is Sticky Strip - ('yes' - 'no') worklogDone - total worklog done dueDate - Strip dueDate time - if present 'dueDate' - for instance "REMAINDER" done - ('yes' - 'no') - Strip done

Returns:

strip created

removeStrip

LicorizeApiResponse removeStrip(int stripId)

Remove the strip identified by the specified ID.

Parameters:

stripId -

Returns:

success or fail operation

changeStripType

LicorizeApiResponse changeStripType(int stripId,
                                    java.lang.String stripType)

Change a strip type.

Parameters:

stripId -

stripType -

Returns:

strip updated

getProjectsList

LicorizeApiResponse getProjectsList()

Return the projects list for the current user.

Returns:

projects list

updateProject

LicorizeApiResponse updateProject(int projectId,
                                  java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Update project.

Parameters:

projectId -

parameters - Optional: name - Team name description - Team description isActive - ('yes' - 'no') isVisible - ('yes' - 'no') code - Team code for public name

Returns:

project updated

createProject

LicorizeApiResponse createProject(java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Create project

Parameters:

parameters - Optional: name - Team name description - Team description isActive - ('yes' - 'no') isVisible - ('yes' - 'no') code - Team code for public name

Returns:

project created

getProject

LicorizeApiResponse getProject(int projectId)

Return the project identified by the specified ID.

Parameters:

projectId -

Returns:

project

getProjectMembers

LicorizeApiResponse getProjectMembers(int projectId)

Return the project members list.

Parameters:

projectId -

Returns:

project members

removeProject

LicorizeApiResponse removeProject(int projectId)

Remove single project identified by the specified ID.

Parameters:

projectId -

Returns:

success or fail operation

getTagsList

LicorizeApiResponse getTagsList()

Show the complete tag cloud.

Returns:

tags list for current user

getUser

LicorizeApiResponse getUser()

Get the current user.

Returns:

current user

getPublicUser

LicorizeApiResponse getPublicUser(java.lang.String userName)

Get user public data from userName.

Parameters:

userName -

Returns:

public user

remindMeLater

LicorizeApiResponse remindMeLater(java.lang.String url)

Method for saving a new remind me later strip.

Parameters:

url - The url that will be saved.

Returns:

The created strip

remindMeLater

LicorizeApiResponse remindMeLater(java.lang.String url,
                                  java.util.List<Parameter<java.lang.String,java.lang.String>> parameters)

Method for save a new remind me later strip.

Parameters:

url - The url that will be saved.

parameters - title - Bookmark title notes - Bookmark Notes tags - Bookmark Tags - Default is "remindMeLater"

Returns:

The created strip