org.shredzone.flattr4j

Interface FlattrService

All Superinterfaces:

OpenService

All Known Implementing Classes:

FlattrServiceImpl

public interface FlattrService
extends OpenService

Service calls to the Flattr REST API which require authorization.

All calls will decrement the remaining rate by one, unless noted otherwise.

Author:

Richard "Shred" Körber

Method Summary

Methods

Modifier and Type	Method and Description
void	click(AutoSubmission submission) Deprecated. use flattr(AutoSubmission) instead
void	click(String url) Deprecated. use flattr(String) instead
void	click(ThingId thingId) Deprecated. use flattr(ThingId) instead
ThingId	create(Submission thing) Creates a new Thing.
void	delete(ThingId thingId) Deletes a Thing.
MiniThing	flattr(AutoSubmission submission) Flattrs an AutoSubmission.
MiniThing	flattr(String url) Flattrs a URL.
MiniThing	flattr(ThingId thingId) Flattrs a Thing.
List<Activity>	getMyActivities(Activity.Type type) Returns all Activity of the associated user.
List<Flattr>	getMyFlattrs() Returns all Flattr submitted by the associated user.
List<Flattr>	getMyFlattrs(Integer count, Integer page) Returns all Flattr submitted by the associated user.
User	getMyself() Gets the User profile of the associated user.
List<Subscription>	getMySubscriptions() Returns all Subscription of the associated user.
List<Thing>	getMyThings() Returns all Thing submitted by the associated user.
List<Thing>	getMyThings(Integer count, Integer page) Returns all Thing submitted by the associated user.
Subscription	getSubscription(ThingId thingId) Returns the Subscription of the given Thing.
void	pauseSubscription(ThingId thingId, boolean paused) Pauses or resumes a Subscription.
void	subscribe(ThingId thingId) Subscribes a Thing.
boolean	toggleSubscription(ThingId thingId) Toggles the pause state of the subscription of the given Thing.
void	unsubscribe(ThingId thingId) Cancels subscription of a Thing.
void	update(Thing thing) Updates a Thing.

Methods inherited from interface org.shredzone.flattr4j.OpenService

getActivities, getCategories, getCurrentRateLimit, getFlattrs, getFlattrs, getFlattrs, getFlattrs, getLanguages, getLastRateLimit, getThing, getThingBySubmission, getThingByUrl, getThings, getThings, getThings, getUser, isFullMode, searchThings, setFullMode

Method Detail

create

@RequiredScope(value=THING)
ThingId create(Submission thing)
               throws FlattrException

Creates a new Thing. The authenticated user will be the owner of the Thing.

Parameters:

thing - Submission to be submitted

Returns:

ThingId of the Thing that was created

Throws:

FlattrException

Since:

2.0

update

@RequiredScope(value=THING)
void update(Thing thing)
            throws FlattrException

Updates a Thing.

Parameters:

thing - Thing to be modified

Throws:

FlattrException

Since:

2.0

delete

@RequiredScope(value=THING)
void delete(ThingId thingId)
            throws FlattrException

Deletes a Thing.

Parameters:

thingId - ThingId to delete

Throws:

FlattrException

Since:

2.0

click

@Deprecated
@RequiredScope(value=FLATTR)
void click(ThingId thingId)
           throws FlattrException

Deprecated. use flattr(ThingId) instead

Flattrs a Thing. This means that the Thing is flattr-ed by the associated user.

Parameters:

thingId - ThingId to flattr

Throws:

FlattrException

click

@Deprecated
@RequiredScope(value=FLATTR)
void click(AutoSubmission submission)
           throws FlattrException

Deprecated. use flattr(AutoSubmission) instead

Flattrs an AutoSubmission. If the submission has not been submitted to Flattr yet, it will automatically be submitted before.

Parameters:

submission - AutoSubmission to flattr

Throws:

FlattrException

click

@Deprecated
@RequiredScope(value=FLATTR)
void click(String url)
           throws FlattrException

Deprecated. use flattr(String) instead

Flattrs a URL.

Parameters:

url - URL to flattr

Throws:

FlattrException

flattr

@RequiredScope(value=FLATTR)
MiniThing flattr(ThingId thingId)
                 throws FlattrException

Flattrs a Thing. This means that the Thing is flattr-ed by the associated user.

Parameters:

thingId - ThingId to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

Since:

2.9

flattr

@RequiredScope(value=FLATTR)
MiniThing flattr(AutoSubmission submission)
                 throws FlattrException

Flattrs an AutoSubmission. If the submission has not been submitted to Flattr yet, it will automatically be submitted before.

Parameters:

submission - AutoSubmission to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

Since:

2.9

flattr

@RequiredScope(value=FLATTR)
MiniThing flattr(String url)
                 throws FlattrException

Flattrs a URL.

Parameters:

url - URL to flattr

Returns:

MiniThing of the flattr-ed thing (containing an updated click count)

Throws:

FlattrException

Since:

2.9

subscribe

@RequiredScope(value=FLATTR)
void subscribe(ThingId thingId)
               throws FlattrException

Subscribes a Thing.

Parameters:

thingId - ThingId to subscribe

Throws:

FlattrException

Since:

2.6

unsubscribe

@RequiredScope(value=FLATTR)
void unsubscribe(ThingId thingId)
                 throws FlattrException

Cancels subscription of a Thing.

Parameters:

thingId - ThingId to unsubscribed

Throws:

FlattrException

Since:

2.6

getMyself

@RequiredScope
User getMyself()
               throws FlattrException

Gets the User profile of the associated user.

Returns:

User profile of oneself

Throws:

FlattrException

getMyThings

@RequiredScope
List<Thing> getMyThings()
                        throws FlattrException

Returns all Thing submitted by the associated user. Limited to 30 entries.

Returns:

List of Thing

Throws:

FlattrException

Since:

2.0

getMyThings

@RequiredScope
List<Thing> getMyThings(Integer count,
                                    Integer page)
                        throws FlattrException

Returns all Thing submitted by the associated user.

Parameters:

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Thing

Throws:

FlattrException

Since:

2.0

getMyFlattrs

@RequiredScope
List<Flattr> getMyFlattrs()
                          throws FlattrException

Returns all Flattr submitted by the associated user. Limited to 30 entries.

Returns:

List of Flattr

Throws:

FlattrException

Since:

2.0

getMyFlattrs

@RequiredScope
List<Flattr> getMyFlattrs(Integer count,
                                      Integer page)
                          throws FlattrException

Returns all Flattr submitted by the associated user.

Parameters:

count - Number of entries per page, null defaults to 30 entries

page - Page number (counted from 1), or null to turn off paging

Returns:

List of Flattr

Throws:

FlattrException

Since:

2.0

getMyActivities

@RequiredScope
List<Activity> getMyActivities(Activity.Type type)
                               throws FlattrException

Returns all Activity of the associated user.

Parameters:

type - activity type. null defaults to Activity.Type#OUTGOING.

Returns:

List of Activity

Throws:

FlattrException

Since:

2.0

getMySubscriptions

@RequiredScope(value=FLATTR)
List<Subscription> getMySubscriptions()
                                      throws FlattrException

Returns all Subscription of the associated user.

Returns:

List of Subscription

Throws:

FlattrException

Since:

2.6

getSubscription

@RequiredScope(value=FLATTR)
Subscription getSubscription(ThingId thingId)
                             throws FlattrException

Returns the Subscription of the given Thing. Only the subscriptions of the associated user are accessible.

Note: This call is emulated by flattr4j. Depending on the number of subscriptions of the associated user, this call may take some time and cause increased network traffic. It may also increment the rate counter by more than 1.

Parameters:

thingId - ThingId to get the subscription of

Returns:

Subscription of this thing, or null if there is no such subscription

Throws:

FlattrException

Since:

2.6

toggleSubscription

@RequiredScope(value=FLATTR)
boolean toggleSubscription(ThingId thingId)
                           throws FlattrException

Toggles the pause state of the subscription of the given Thing.

Parameters:

thingId - ThingId of the thing to toggle the pause state of

Returns:

true if the subscription is now paused, false if the subscription was resumed.

Throws:

FlattrException

Since:

2.6

pauseSubscription

@RequiredScope(value=FLATTR)
void pauseSubscription(ThingId thingId,
                                              boolean paused)
                       throws FlattrException

Pauses or resumes a Subscription. If the subscription is already in the desired state, nothing will happen.

Note: There is currently no way to explicitely set the pause state of a subscription via Flattr API. flattr4j emulates this call by toggling the pause state to get the current state, and if necessary, toggling it again to set the subscription to the desired state (which means that the rate counter is incremented by 2). This call is not atomic. If the second toggle call should fail, it will leave the subscription in the opposite state.

Parameters:

thingId - ThingId of the thing to set the pause state

paused - true: pause subscription, false: resume subscription

Throws:

FlattrException

Since:

2.6