com.nulabinc.backlog4j.api

Interface WatchingMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface WatchingMethods

Executes Backlog Watch APIs.

Method Summary

Modifier and Type	Method and Description
Watch	addWatchToIssue(java.lang.Object watchingId, java.lang.String note) Adds a watching to the issue.
Watch	deleteWatch(java.lang.Object watchingId) Deletes the existing watching.
Watch	getWatch(java.lang.Long watchingId) Returns the Watch.
void	markAsCheckedUserWatches(java.lang.Object numericUserId) Marks the watching as already read.
Watch	updateWatch(UpdateWatchParams params) Updates the existing watching.

Method Detail

getWatch

Watch getWatch(java.lang.Long watchingId)
        throws BacklogException

Returns the Watch.

Parameters:

watchingId -

Returns:

the Watch

Throws:

BacklogException

addWatchToIssue

Watch addWatchToIssue(java.lang.Object watchingId,
                      java.lang.String note)
               throws BacklogException

Adds a watching to the issue.

Parameters:

watchingId - the issue identifier

note -

Throws:

BacklogException

updateWatch

Watch updateWatch(UpdateWatchParams params)
           throws BacklogException

Updates the existing watching.

Parameters:

params - the updating project parameters

Returns:

the updated Watching

Throws:

BacklogException

deleteWatch

Watch deleteWatch(java.lang.Object watchingId)
           throws BacklogException

Deletes the existing watching.

Parameters:

watchingId - the watching identifier

Returns:

the deleted watching

Throws:

BacklogException

markAsCheckedUserWatches

void markAsCheckedUserWatches(java.lang.Object numericUserId)
                       throws BacklogException

Marks the watching as already read.

Parameters:

numericUserId - the user identifier

Throws:

BacklogException