org.diylc.plugins.cloud.model
Interface IServiceAPI

public interface IServiceAPI

Interface of DIYLC PHP server located at www.diy-fever.com/diylc/api/v1

Author:

bancika

Field Summary

static java.lang.String

URL_KEY

Method Summary

java.lang.String	createUser(java.lang.String username, java.lang.String password, java.lang.String email, java.lang.String website, java.lang.String bio) Creates a user with the specified details.
java.util.List<java.lang.String>	getCategories()
java.lang.Object	getComments(int projectId) Returns all available comments for the given projectId.
java.util.List<java.lang.String>	getSortings()
java.lang.Object	getUserDetails(java.lang.String username, java.lang.String token, java.lang.String machineId) Retrieves current user's details.
java.lang.String	login(java.lang.String username, java.lang.String password, java.lang.String machineId) Tries to login with the provided credentials and machineId.
java.lang.String	loginWithToken(java.lang.String username, java.lang.String token, java.lang.String machineId) Tries to authenticate with the token that was previously created by calling login() function.
java.lang.String	postComment(java.lang.String username, java.lang.String token, java.lang.String machineId, java.lang.Integer projectId, java.lang.String comment) Posts a comment to the specified project.
java.lang.Object	search(java.lang.String criteria, java.lang.String category, java.lang.Integer page, java.lang.Integer itemsPerPage, java.lang.String sort) Searches for projects that meet the specified search criteria.
java.lang.String	updatePassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) Updates password of the current user using token to authenticate.
java.lang.String	updateUserDetails(java.lang.String username, java.lang.String token, java.lang.String machineId, java.lang.String email, java.lang.String website, java.lang.String bio) Updates user details using token to authenticate.
java.lang.String	upload(java.lang.String username, java.lang.String token, java.lang.String machineId, java.lang.String projectName, java.lang.String category, java.lang.String description, java.lang.String diylcVersion, java.lang.String keywords, java.io.File thumbnail, java.io.File project) Uploads a project using token to authenticate.

Field Detail

URL_KEY

static final java.lang.String URL_KEY

See Also:

Constant Field Values

Method Detail

createUser

java.lang.String createUser(java.lang.String username,
                            java.lang.String password,
                            java.lang.String email,
                            java.lang.String website,
                            java.lang.String bio)

Creates a user with the specified details.

Parameters:

username -

password -

email -

website -

bio -

Returns:

"Success" if the operation is successful or error message if it failed.

updateUserDetails

java.lang.String updateUserDetails(java.lang.String username,
                                   java.lang.String token,
                                   java.lang.String machineId,
                                   java.lang.String email,
                                   java.lang.String website,
                                   java.lang.String bio)

Updates user details using token to authenticate.

Parameters:

username -

token -

machineId -

email -

website -

bio -

Returns:

"Success" if the operation is successful or error message if it failed.

login

java.lang.String login(java.lang.String username,
                       java.lang.String password,
                       java.lang.String machineId)

Tries to login with the provided credentials and machineId.

Parameters:

username -

password -

machineId -

Returns:

login token if the login was successful or string literal "Error" if it failed.

getUserDetails

java.lang.Object getUserDetails(java.lang.String username,
                                java.lang.String token,
                                java.lang.String machineId)

Retrieves current user's details.

Parameters:

username -

password -

machineId -

Returns:

string with an error message if it fails, or an instance of UserEntity if it succeeds.

loginWithToken

java.lang.String loginWithToken(java.lang.String username,
                                java.lang.String token,
                                java.lang.String machineId)

Tries to authenticate with the token that was previously created by calling login() function.

Parameters:

username -

password -

machineId -

Returns:

"Success" if the login is successful or error message if it failed.

updatePassword

java.lang.String updatePassword(java.lang.String username,
                                java.lang.String oldPassword,
                                java.lang.String newPassword)

Updates password of the current user using token to authenticate.

Parameters:

username -

token -

machineId -

password -

Returns:

"Success" if the login is successful or error message if it failed.

search

java.lang.Object search(java.lang.String criteria,
                        java.lang.String category,
                        java.lang.Integer page,
                        java.lang.Integer itemsPerPage,
                        java.lang.String sort)

Searches for projects that meet the specified search criteria. Supports pagination.

Parameters:

criteria -

category -

page -

itemsPerPage -

sort -

Returns:

string with error message if the error occurred or a list of ProjectEntity objects.

upload

java.lang.String upload(java.lang.String username,
                        java.lang.String token,
                        java.lang.String machineId,
                        java.lang.String projectName,
                        java.lang.String category,
                        java.lang.String description,
                        java.lang.String diylcVersion,
                        java.lang.String keywords,
                        java.io.File thumbnail,
                        java.io.File project)

Uploads a project using token to authenticate.

Parameters:

username -

token -

machineId -

projectName -

category -

description -

diylcVersion -

keywords -

thumbnail -

project -

Returns:

"Success" if the upload was successful or error message if it failed.

postComment

java.lang.String postComment(java.lang.String username,
                             java.lang.String token,
                             java.lang.String machineId,
                             java.lang.Integer projectId,
                             java.lang.String comment)

Posts a comment to the specified project.

Parameters:

username -

token -

machineId -

projectId -

comment -

Returns:

getCategories

java.util.List<java.lang.String> getCategories()

Returns:

a List of available categories.

getSortings

java.util.List<java.lang.String> getSortings()

Returns:

a List of available sortings.

getComments

java.lang.Object getComments(int projectId)

Returns all available comments for the given projectId.

Parameters:

projectId -

Returns:

string with error message if the error occurred or a list of CommentEntity objects.