com.fr31b3u73r.jodel

Class JodelAccount

java.lang.Object

com.fr31b3u73r.jodel.JodelAccount

public class JodelAccount
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JodelAccount(java.lang.String lat, java.lang.String lng, java.lang.String city, java.lang.String country, java.lang.String name) Overloads constructor to simplify creating a new account
JodelAccount(java.lang.String lat, java.lang.String lng, java.lang.String city, java.lang.String country, java.lang.String name, java.lang.Boolean updateLocation, JodelAccountData accountData) Overloads constructor using JodelAccountData object instead of single values for account data
JodelAccount(java.lang.String lat, java.lang.String lng, java.lang.String city, java.lang.String country, java.lang.String name, java.lang.Boolean updateLocation, java.lang.String accessToken, java.lang.String deviceUID, java.lang.String refreshToken, java.lang.String distinctID, java.lang.String expirationDate) Constructor for JodelAccount class

Method Summary

Modifier and Type	Method and Description
JodelRequestResponse	createPost(java.lang.String message, java.lang.String base64Image, java.lang.String color, java.lang.String channel) Creates a new Jodel with no ancestor (i.e. no reply)
JodelRequestResponse	createPost(java.lang.String message, java.lang.String base64Image, java.lang.String color, java.lang.String channel, int ancestor) Creates a new Jodel
JodelRequestResponse	deleteJodel(java.lang.String postID) Deletes a (own) Jodel
JodelRequestResponse	disableNotification(java.lang.String postID) Disables notifications of a Jodel
JodelRequestResponse	dismissStickyJodel(java.lang.String postID) Dismisses a sticky Jodel
JodelRequestResponse	downvoteJodel(java.lang.String postID) Downvotes a post
JodelRequestResponse	downvoteStickyJodel(java.lang.String postID) Downvotes a sticky Jodel
JodelRequestResponse	enableNotification(java.lang.String postID) Enable notifications of a Jodel
JodelRequestResponse	followChannel(java.lang.String channel) Follows a channel
JodelAccountData	getAccountData() Returns current account data as object of type JodelAccountData
JodelRequestResponse	getCaptchaData() Gets the captcha image url and key for not verified users
JodelRequestResponse	getChannelMeta(java.lang.String channel) Gets metadata of a channel
JodelRequestResponse	getJodelShareLink(java.lang.String postID) Get share url
JodelRequestResponse	getKarma() Gets your karma
JodelRequestResponse	getMyPinnedPosts(int skip, int limit, java.lang.String after) Gets your pinned Jodels matching given criteria
JodelRequestResponse	getMyRepliedPosts(int skip, int limit, java.lang.String after) Gets Jodels you replied to matching given criteria
JodelRequestResponse	getMyVotedPosts(int skip, int limit, java.lang.String after) Gets Jodels you voted to matching given criteria
JodelRequestResponse	getNotifications() Gets Notifications for current account
JodelRequestResponse	getNotificationsNew() Gets new Notifications for current account
JodelRequestResponse	getPicturesDiscussed(int skip, int limit, java.lang.String after) Gets most discussed picture Jodels matching given criteria
JodelRequestResponse	getPicturesPopular(int skip, int limit, java.lang.String after) Gets popular picture Jodels matching given criteria
JodelRequestResponse	getPicturesRecent(int skip, int limit, java.lang.String after) Gets recent picture Jodels matching given criteria
JodelRequestResponse	getPostDetails(java.lang.String postID) Gets a single Jodel with all replies by post ID
JodelRequestResponse	getPostDetailsV3(java.lang.String postID, int skip) Gets a single Jodel in new V3 of endpoint with all replies by post ID
JodelRequestResponse	getPosts(java.lang.String postTypes, int skip, int limit, java.lang.String after, boolean mine, java.lang.String hashtag, java.lang.String channel, boolean pictures) Gets Jodels matching given criteria
JodelRequestResponse	getPostsDiscussed(int skip, int limit, java.lang.String after, boolean mine, java.lang.String hashtag, java.lang.String channel) Gets most discussed Jodels matching given criteria
JodelRequestResponse	getPostsPopular(int skip, int limit, java.lang.String after, boolean mine, java.lang.String hashtag, java.lang.String channel) Gets popular Jodels matching given criteria
JodelRequestResponse	getPostsRecent(int skip, int limit, java.lang.String after, boolean mine, java.lang.String hashtag, java.lang.String channel) Gets recent Jodels matching given criteria
JodelRequestResponse	getRecommendedChannels() Gets the recommended channels
JodelRequestResponse	pinJodel(java.lang.String postID) Pins a Jodel
void	refreshAccessToken() Refreshes the Access Token of the currently used account
void	refreshAllTokens() Creates a new account with random ID if self.device_uid is not set.
JodelRequestResponse	setNotificationRead(java.lang.String postID, java.lang.String notificationID) Sets a notification "read" by postID or notificationID
JodelRequestResponse	setUserProfile(java.lang.String userType, java.lang.String gender, int age) Sets the user profile
JodelRequestResponse	thankJodel(java.lang.String postID) Thanks a post
JodelRequestResponse	unfollowChannel(java.lang.String channel) Unfollows a channel
JodelRequestResponse	unpinJodel(java.lang.String postID) Unpins a Jodel
JodelRequestResponse	upvoteJodel(java.lang.String postID) Upvotes a post
JodelRequestResponse	upvoteStickyJodel(java.lang.String postID) Upvotes a sticky Jodel
JodelRequestResponse	verifyCaptcha(java.lang.String key, java.util.List<java.lang.Integer> positions) Solves the captcha so that a user can verify his account

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JodelAccount

public JodelAccount(java.lang.String lat,
                    java.lang.String lng,
                    java.lang.String city,
                    java.lang.String country,
                    java.lang.String name,
                    java.lang.Boolean updateLocation,
                    java.lang.String accessToken,
                    java.lang.String deviceUID,
                    java.lang.String refreshToken,
                    java.lang.String distinctID,
                    java.lang.String expirationDate)

Constructor for JodelAccount class

Parameters:

lat - Latitute of location

lng - Longitude of location

city - Name of the city

country - Countrycode (e.g. DE for Germany)

name - Name of the location (normally the same as city)

updateLocation - Boolean to update a location for existing account

accessToken - Access token of account

deviceUID - Device ID of account

refreshToken - Refresh token of account

distinctID - Distinct ID of account

expirationDate - Timestamp of expiration date

JodelAccount

public JodelAccount(java.lang.String lat,
                    java.lang.String lng,
                    java.lang.String city,
                    java.lang.String country,
                    java.lang.String name,
                    java.lang.Boolean updateLocation,
                    JodelAccountData accountData)

Overloads constructor using JodelAccountData object instead of single values for account data

Parameters:

lat - Latitute of location

lng - Longitude of location

city - Name of the city

country - Countrycode (e.g. DE for Germany)

name - Name of the location (normally the same as city)

updateLocation - Boolean to update a location for existing account

accountData - Object of type JodelAccountData containing all necessary account data

JodelAccount

public JodelAccount(java.lang.String lat,
                    java.lang.String lng,
                    java.lang.String city,
                    java.lang.String country,
                    java.lang.String name)

Overloads constructor to simplify creating a new account

Parameters:

lat - Latitute of location

lng - Longitude of location

city - Name of the city

country - Countrycode (e.g. DE for Germany)

name - Name of the location (normally the same as city)

Method Detail

getAccountData

public JodelAccountData getAccountData()

Returns current account data as object of type JodelAccountData

Returns:

Account data

refreshAllTokens

public void refreshAllTokens()

Creates a new account with random ID if self.device_uid is not set. Otherwise renews all tokens of the account with ID = this.device_uid.

refreshAccessToken

public void refreshAccessToken()

Refreshes the Access Token of the currently used account

getCaptchaData

public JodelRequestResponse getCaptchaData()

Gets the captcha image url and key for not verified users

Returns:

Object of type JodelRequestResponse containing captcha URL and key in responseValues attribute

verifyCaptcha

public JodelRequestResponse verifyCaptcha(java.lang.String key,
                                          java.util.List<java.lang.Integer> positions)

Solves the captcha so that a user can verify his account

Parameters:

key - Key of captcha

positions - List of positions with racoon (starting with 0 from left to right)

Returns:

The requestResponse of type JodelRequestResponse

createPost

public JodelRequestResponse createPost(java.lang.String message,
                                       java.lang.String base64Image,
                                       java.lang.String color,
                                       java.lang.String channel,
                                       int ancestor)

Creates a new Jodel

Parameters:

message - Text message for new Jodel

base64Image - Base64 encoded image

color - Color of the Jodel

channel - Channel to post Jodel to

ancestor - For replies specify an ancestor

Returns:

The requestResponse of type JodelRequestResponse

createPost

public JodelRequestResponse createPost(java.lang.String message,
                                       java.lang.String base64Image,
                                       java.lang.String color,
                                       java.lang.String channel)

Creates a new Jodel with no ancestor (i.e. no reply)

Parameters:

message - Text message for new Jodel

base64Image - Base64 encoded image

color - Color of the Jodel

channel - Channel to post Jodel to

Returns:

The requestResponse of type JodelRequestResponse

getPosts

public JodelRequestResponse getPosts(java.lang.String postTypes,
                                     int skip,
                                     int limit,
                                     java.lang.String after,
                                     boolean mine,
                                     java.lang.String hashtag,
                                     java.lang.String channel,
                                     boolean pictures)

Gets Jodels matching given criteria

Parameters:

postTypes - Types of Jodels to return (e.g. popular, discussed etc.)

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

mine - Boolean to set output to only own Jodels

hashtag - Hashtag to filter Jodels

channel - Channel to filter Jodels

pictures - Boolean for selecting pictures

Returns:

The requestResponse of type JodelRequestResponse

getPostsRecent

public JodelRequestResponse getPostsRecent(int skip,
                                           int limit,
                                           java.lang.String after,
                                           boolean mine,
                                           java.lang.String hashtag,
                                           java.lang.String channel)

Gets recent Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

mine - Boolean to set output to only own Jodels

hashtag - Hashtag to filter Jodels

channel - Channel to filter Jodels

Returns:

The requestResponse of type JodelRequestResponse

getPostsPopular

public JodelRequestResponse getPostsPopular(int skip,
                                            int limit,
                                            java.lang.String after,
                                            boolean mine,
                                            java.lang.String hashtag,
                                            java.lang.String channel)

Gets popular Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

mine - Boolean to set output to only own Jodels

hashtag - Hashtag to filter Jodels

channel - Channel to filter Jodels

Returns:

The requestResponse of type JodelRequestResponse

getPostsDiscussed

public JodelRequestResponse getPostsDiscussed(int skip,
                                              int limit,
                                              java.lang.String after,
                                              boolean mine,
                                              java.lang.String hashtag,
                                              java.lang.String channel)

Gets most discussed Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

mine - Boolean to set output to only own Jodels

hashtag - Hashtag to filter Jodels

channel - Channel to filter Jodels

Returns:

The requestResponse of type JodelRequestResponse

getPicturesRecent

public JodelRequestResponse getPicturesRecent(int skip,
                                              int limit,
                                              java.lang.String after)

Gets recent picture Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getPicturesPopular

public JodelRequestResponse getPicturesPopular(int skip,
                                               int limit,
                                               java.lang.String after)

Gets popular picture Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getPicturesDiscussed

public JodelRequestResponse getPicturesDiscussed(int skip,
                                                 int limit,
                                                 java.lang.String after)

Gets most discussed picture Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getMyPinnedPosts

public JodelRequestResponse getMyPinnedPosts(int skip,
                                             int limit,
                                             java.lang.String after)

Gets your pinned Jodels matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getMyRepliedPosts

public JodelRequestResponse getMyRepliedPosts(int skip,
                                              int limit,
                                              java.lang.String after)

Gets Jodels you replied to matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getMyVotedPosts

public JodelRequestResponse getMyVotedPosts(int skip,
                                            int limit,
                                            java.lang.String after)

Gets Jodels you voted to matching given criteria

Parameters:

skip - Skip value

limit - Limit returned Jodels to a certain number

after - Return only Jodels after a certain post

Returns:

The requestResponse of type JodelRequestResponse

getPostDetails

public JodelRequestResponse getPostDetails(java.lang.String postID)

Gets a single Jodel with all replies by post ID

Parameters:

postID - ID of the post to retrieve details for

Returns:

The requestResponse of type JodelRequestResponse

getPostDetailsV3

public JodelRequestResponse getPostDetailsV3(java.lang.String postID,
                                             int skip)

Gets a single Jodel in new V3 of endpoint with all replies by post ID

Parameters:

postID - ID of the post to retrieve details for

skip - Skip value

Returns:

The requestResponse of type JodelRequestResponse

upvoteJodel

public JodelRequestResponse upvoteJodel(java.lang.String postID)

Upvotes a post

Parameters:

postID - ID of the post to vote

Returns:

The requestResponse of type JodelRequestResponse

downvoteJodel

public JodelRequestResponse downvoteJodel(java.lang.String postID)

Downvotes a post

Parameters:

postID - ID of the post to vote

Returns:

The requestResponse of type JodelRequestResponse

thankJodel

public JodelRequestResponse thankJodel(java.lang.String postID)

Thanks a post

Parameters:

postID - ID of the post to thank

Returns:

The requestResponse of type JodelRequestResponse

getJodelShareLink

public JodelRequestResponse getJodelShareLink(java.lang.String postID)

Get share url

Parameters:

postID - ID of the post to share

Returns:

The requestResponse of type JodelRequestResponse

pinJodel

public JodelRequestResponse pinJodel(java.lang.String postID)

Pins a Jodel

Parameters:

postID - ID of the post to pin

Returns:

The requestResponse of type JodelRequestResponse

unpinJodel

public JodelRequestResponse unpinJodel(java.lang.String postID)

Unpins a Jodel

Parameters:

postID - ID of the post to unpin

Returns:

The requestResponse of type JodelRequestResponse

enableNotification

public JodelRequestResponse enableNotification(java.lang.String postID)

Enable notifications of a Jodel

Parameters:

postID - ID of the post to enable notification

Returns:

The requestResponse of type JodelRequestResponse

disableNotification

public JodelRequestResponse disableNotification(java.lang.String postID)

Disables notifications of a Jodel

Parameters:

postID - ID of the post to disable notification

Returns:

The requestResponse of type JodelRequestResponse

deleteJodel

public JodelRequestResponse deleteJodel(java.lang.String postID)

Deletes a (own) Jodel

Parameters:

postID - ID of the post to delete

Returns:

The requestResponse of type JodelRequestResponse

upvoteStickyJodel

public JodelRequestResponse upvoteStickyJodel(java.lang.String postID)

Upvotes a sticky Jodel

Parameters:

postID - ID of the sticky post to upvote

Returns:

The requestResponse of type JodelRequestResponse

downvoteStickyJodel

public JodelRequestResponse downvoteStickyJodel(java.lang.String postID)

Downvotes a sticky Jodel

Parameters:

postID - ID of the sticky post to downvote

Returns:

The requestResponse of type JodelRequestResponse

dismissStickyJodel

public JodelRequestResponse dismissStickyJodel(java.lang.String postID)

Dismisses a sticky Jodel

Parameters:

postID - ID of the sticky post to dismiss

Returns:

The requestResponse of type JodelRequestResponse

getNotifications

public JodelRequestResponse getNotifications()

Gets Notifications for current account

Returns:

The requestResponse of type JodelRequestResponse

getNotificationsNew

public JodelRequestResponse getNotificationsNew()

Gets new Notifications for current account

Returns:

The requestResponse of type JodelRequestResponse

setNotificationRead

public JodelRequestResponse setNotificationRead(java.lang.String postID,
                                                java.lang.String notificationID)

Sets a notification "read" by postID or notificationID

Parameters:

postID - ID of the post to set notification read

notificationID - ID of the notification to set read

Returns:

The requestResponse of type JodelRequestResponse

getRecommendedChannels

public JodelRequestResponse getRecommendedChannels()

Gets the recommended channels

Returns:

The requestResponse of type JodelRequestResponse

getChannelMeta

public JodelRequestResponse getChannelMeta(java.lang.String channel)

Gets metadata of a channel

Parameters:

channel - Name of the channel

Returns:

The requestResponse of type JodelRequestResponse

followChannel

public JodelRequestResponse followChannel(java.lang.String channel)

Follows a channel

Parameters:

channel - Name of the channel

Returns:

The requestResponse of type JodelRequestResponse

unfollowChannel

public JodelRequestResponse unfollowChannel(java.lang.String channel)

Unfollows a channel

Parameters:

channel - Name of the channel

Returns:

The requestResponse of type JodelRequestResponse

setUserProfile

public JodelRequestResponse setUserProfile(java.lang.String userType,
                                           java.lang.String gender,
                                           int age)

Sets the user profile

Parameters:

userType - Type of user (as defined in JodelUsertype)

gender - Gender (m or f)

age - Age of the user

Returns:

The requestResponse of type JodelRequestResponse

getKarma

public JodelRequestResponse getKarma()

Gets your karma

Returns:

The requestResponse of type JodelRequestResponse