Package com.podio.status
Class StatusAPI
- java.lang.Object
-
- com.podio.BaseAPI
-
- com.podio.status.StatusAPI
-
public class StatusAPI extends BaseAPI
Status messages are small texts that the users wishes to share with the other users in a space. It can be anything from a note that the user will be in later today over links to interesting resources and information about what the user is working on a the moment. Other users can comment on a status message and indicate that they like the status message.
-
-
Constructor Summary
Constructors Constructor Description StatusAPI(ResourceFactory resourceFactory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcreateStatus(int spaceId, StatusCreate status)Creates a new status message for a user on a specific space.voiddeleteStatus(int statusId)This is used to delete a status message.StatusFullgetStatus(int statusId)Retrieves a status message by its id.voidupdateStatus(int statusId, StatusUpdate update)This will update an existing status message.-
Methods inherited from class com.podio.BaseAPI
getResourceFactory
-
-
-
-
Constructor Detail
-
StatusAPI
public StatusAPI(ResourceFactory resourceFactory)
-
-
Method Detail
-
createStatus
public int createStatus(int spaceId, StatusCreate status)Creates a new status message for a user on a specific space. A status update is simply a short text message that the user wishes to share with the rest of the space.- Parameters:
status- The data for the new status message- Returns:
- The id of the newly created status message
-
deleteStatus
public void deleteStatus(int statusId)
This is used to delete a status message. This is normally only done if the user regrets his status update. After deletion the status message will no longer be viewable by anyone.- Parameters:
statusId- The id of the status to delete
-
getStatus
public StatusFull getStatus(int statusId)
Retrieves a status message by its id. The id of the status message is usually gotten from the stream.- Parameters:
statusId- The id of the status- Returns:
- The status message
-
updateStatus
public void updateStatus(int statusId, StatusUpdate update)This will update an existing status message. This will normally only be used to correct spelling and grammatical mistakes.- Parameters:
statusId- The id of the status to be updatedupdate- The new data for the status
-
-