|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objecths.lib.HeyStaksMethods
public class HeyStaksMethods
The following class contains all the methods we need for interacting with HeyStaks.
| Constructor Summary | |
|---|---|
HeyStaksMethods(CallBuilder build)
Pass in the builder to set API params (key, secret, etc.) |
|
| Method Summary | |
|---|---|
boolean |
addPageToStak(HsLogin login,
int stakid,
Page page)
Add's a page to a given Stak |
Stak |
createStak(java.lang.String stakName,
java.lang.String type,
java.lang.String description,
java.lang.String tags,
HsLogin login)
Creates a Stak on HeyStaks |
ListOfPages |
getPagesInStak(HsLogin login,
Stak stak)
Returns all the pages located inside a given Stak. |
HsUser |
getUserData(HsLogin login)
Returns the users HeyStaks data. |
ListOfStaks |
getUsersStaks(HsLogin login)
Gets a list of the Users Staks from HeyStaks. |
HsLogin |
HeyStaksAuth(java.lang.String username,
java.lang.String password)
When given a Username and password it will log the user into HeyStaks. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public HeyStaksMethods(CallBuilder build)
build - the CallBuilder object.| Method Detail |
|---|
public HsLogin HeyStaksAuth(java.lang.String username,
java.lang.String password)
throws java.security.NoSuchAlgorithmException
username - the clients username.password - the clients password.
java.security.NoSuchAlgorithmExceptionpublic HsUser getUserData(HsLogin login)
login - The HsLogin object.
public Stak createStak(java.lang.String stakName,
java.lang.String type,
java.lang.String description,
java.lang.String tags,
HsLogin login)
stakName - The Staks nametype - It's type (Public or Private)description - The Staks descriptiontags - The tags to be used with the Staklogin - the HsLogin object.
public boolean addPageToStak(HsLogin login,
int stakid,
Page page)
login - the login object.stakid - the Stak IDthe - page object of the page to be added.
public ListOfStaks getUsersStaks(HsLogin login)
user - user object
public ListOfPages getPagesInStak(HsLogin login,
Stak stak)
login - the HsLogin objectstak - the Stak.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||