Class: plurk_api
Source Location: /plurk_api.php
This is a PHP Plurk API.
Author(s):
Version:
|
|
Class Details
Class Methods
constructor __construct [line 92]
String contains proxy authentication for CURL connection
Tags:
method addPlurk [line 1681]
boolean addPlurk(
[
$lang = 'en'], [
$qualifier = 'says'], [
$content = 'test from roga-plurk-api'], [
$limited_to = NULL], [
$no_comments = 0])
|
|
function addPlurk Compatible with RLPlurkAPI
Parameters:
method add_all_as_fan [line 1184]
Boolean add_all_as_fan(
)
|
|
function add_all_as_fan Accept all friendship requests as fans.
Tags:
method add_all_as_friends [line 1202]
boolean add_all_as_friends(
)
|
|
function add_all_as_friends Accept all friendship requests as friends.
Tags:
method add_as_fan [line 1141]
Boolean add_as_fan(
[int
$user_id = 0])
|
|
function add_as_fan Accept user_id as fan.
Tags:
Parameters:
method add_as_friend [line 1163]
Boolean add_as_friend(
[int
$user_id = 0])
|
|
function add_as_friend Accept user_id as friend.
Tags:
Parameters:
method add_plurk [line 605]
JSON add_plurk(
[string
$lang = 'en'], [string
$qualifier = 'says'], [string
$content = 'test from plurk-api'], [$limited_to
$limited_to = NULL], [
$no_comments = 0], int
$no_commetns)
|
|
function add_Plurk
Tags:
Parameters:
method add_response [line 857]
JSON add_response(
[int
$plurk_id = 0], [string
$content = ''], [string
$qualifier = 'says'])
|
|
function add_response
Tags:
Parameters:
method add_to_clique [line 1492]
boolean add_to_clique(
[string
$clique_name = ''], [int
$user_id = 0])
|
|
function add_to_clique add friend to clique
Tags:
Parameters:
method become_fan [line 1046]
boolean become_fan(
[int
$fan_id = 0])
|
|
function become_fan
Tags:
Parameters:
method become_friend [line 1004]
boolean become_friend(
[int
$friend_id = 0])
|
|
function become_friend
Tags:
Parameters:
method befriend [line 1747]
void befriend(
[array
$array_uid = null], [
$bool_befriend = false])
|
|
function befriend Compatible with RLPlurkAPI
Tags:
Parameters:
method blockUser [line 1812]
bool blockUser(
[array
$array_uid = null])
|
|
function blockUser Compatible with RLPlurkAPI
Tags:
Parameters:
method block_user [line 1362]
boolean block_user(
[int
$user_id = 0])
|
|
funciton block_user
Tags:
Parameters:
method create_clique [line 1439]
boolean create_clique(
[string
$clique_name = ''])
|
|
function create_clique create clique
Tags:
Parameters:
method deletePlurk [line 1694]
bool deletePlurk(
array
$int_plurk_id)
|
|
function deletePlurk Compatible with RLPlurkAPI delete a plurk
Tags:
Parameters:
method delete_plurk [line 637]
boolean delete_plurk(
[
$plurk_id = 0], int
$plurk_id:)
|
|
function delete_plurk
Tags:
Parameters:
method delete_response [line 887]
boolean delete_response(
[int
$plurk_id = 0], [int
$response_id = 0])
|
|
function delete_response
Tags:
Parameters:
method denyFriendMakeFan [line 1776]
void denyFriendMakeFan(
[array
$array_uid = null])
|
|
function denyFriendMakeFan Compatible with RLPlurkAPI
Tags:
Parameters:
method deny_friendship [line 1221]
Boolean deny_friendship(
[int
$user_id = 0])
|
|
function deny_friendship Deny friendship to user_id.
Tags:
Parameters:
method edit_plurk [line 659]
JSON edit_plurk(
[int
$plurk_id = 0], [string
$content = ''])
|
|
function edit_plurk
Tags:
Parameters:
method favorite_plurk [line 729]
boolean favorite_plurk(
$ids
$ids)
|
|
function favorite_plurk
Tags:
Parameters:
method getAlerts [line 1735]
function getAlerts Compatible with RLPlurkAPI
Tags:
method getBlockedUsers [line 1800]
function getBlockedUsers Compatible with RLPlurkAPI Get my list of blocked users.
Tags:
method getCities [line 1931]
array getCities(
[int
$int_uid = null], [int
$int_region_id = null])
|
|
function getCities Compatible with RLPlurkAPI Get cities.
Tags:
Parameters:
method getCountries [line 1960]
array getCountries(
[int
$int_uid = null])
|
|
function getCountries Compatible with RLPlurkAPI Get thie list of countries.
Tags:
Parameters:
method getPermalink [line 1903]
string getPermalink(
int
$plurk_id)
|
|
function getPermalink Compatible with RLPlurkAPI Convert a plurk ID to a permalink URL.
Tags:
Parameters:
method getPlurks [line 1626]
array getPlurks(
[int
$int_uid = null], [string
$date_from = null], [string
$date_offset = null], [bool
$fetch_responses = false], [bool
$self_plurks_only = false])
|
|
function getPlurks Compatible with RLPlurkAPI Gets the plurks for the user. Only 25 plurks are fetch at a time as this is limited on the server. The array returned is ordered most recent post first followed by previous posts.
Tags:
Parameters:
method getRegions [line 1946]
array getRegions(
[int
$int_uid = null], [int
$int_country_id = null])
|
|
function getRegions Compatible with RLPlurkAPI Get the regions in a given country.
Tags:
Parameters:
method getResponses [line 1707]
array getResponses(
int
$int_plurk_id)
|
|
function getResponses Compatible with RLPlurkAPI Get the responses of a plurk. This method will load "temporary" friends who have responded to the plurk.
Tags:
Parameters:
method getUnreadPlurks [line 1640]
array getUnreadPlurks(
[bool
$fetch_responses = false])
|
|
function getUnreadPlurks Compatible with RLPlurkAPI Get the unread plurks.
Tags:
Parameters:
method get_active [line 1107]
function get_active Return a JSON list of current active alert
Tags:
method get_blocks [line 1342]
JSON get_blocks(
[int
$offset = 0])
|
|
function get_blocks
Tags:
Parameters:
method get_clique [line 1419]
array get_clique(
[string
$clique_name = ''])
|
|
function get_clique get users from clique
Tags:
Parameters:
method get_cliques [line 1402]
function get_cliques
Tags:
method get_completion [line 1091]
function get_completion Returns a JSON object of the logged in users friends (nick name and full name).
Tags:
method get_emoticons [line 1324]
function get_emoticons Emoticons are a big part of Plurk since they make it easy to express feelings. <a href="http://www.plurk.com/Help/extraSmilies">Check out current Plurk emoticons.</a> This call returns a JSON object that looks like: $link http://www.plurk.com/Help/extraSmilies Check out current Plurk emoticons.
Tags:
method get_fans [line 965]
JSON get_fans(
[int
$user_id = 0], [int
$offset = 0])
|
|
function get_fans
Tags:
Parameters:
method get_following [line 985]
JSON get_following(
[int
$offset = 0])
|
|
function get_following
Tags:
Parameters:
method get_friends [line 946]
JSON get_friends(
[int
$user_id = 0], [int
$offset = 0])
|
|
function get_friends
Tags:
Parameters:
method get_history [line 1124]
function get_history Return a JSON list of past 30 alerts.
Tags:
Parameters:
method get_http_response [line 1559]
function get_http_response Get HTTP Server Response
method get_http_status [line 1548]
function get_http_status Get HTTP Status Code
method get_karma_stats [line 400]
function get_karma_stats Returns info about a user's karma, including current karma, karma growth, karma graph and the latest reason why the karma has dropped. karma_trend: Returns a list of 30 recent karma updates. Each update is a string '[[unixtimestamp]]-[[karma_value]]', e.g. a valid entry is '1282046402-97.85' karma_fall_reason: Why did karma drop? This value is a string and can be: friends_rejections, inactivity, too_short_responses http://www.plurk.com/API#/API/Users/getKarmaStats
Tags:
method get_login_status [line 1537]
boolean get_login_status(
)
|
|
function get_login_status Get login status
method get_own_profile [line 908]
function get_own_profile
Tags:
method get_permalink [line 1582]
string. get_permalink(
$plurk_id
$plurk_id)
|
|
function get_permalink transfer plurk_id to permalink
Parameters:
method get_plurk [line 521]
JSON get_plurk(
[int
$plurk_id = 0])
|
|
function get_plurk
Tags:
Parameters:
method get_plurks [line 545]
JSON get_plurks(
[time
$offset = NULL], [int
$limit = 20], [boolean
$only_user = NULL], [boolean
$only_responded = NULL], [boolean
$only_private = NULL], [boolean
$only_favorite = NULL])
|
|
function get_plurks
Tags:
Parameters:
method get_plurks_polling [line 479]
JSON get_plurks_polling(
[time
$offset = NULL], [int
$limit = 50])
|
|
function get_plurks_polling
Tags:
Parameters:
method get_plurks_polling_unread_count [line 501]
int get_plurks_polling_unread_count(
)
|
|
function get_plurks_polling_unread_count Use this call to find out if there are unread plurks on a user's timeline.
Tags:
method get_plurk_id [line 1594]
int. get_plurk_id(
$permalink
$permalink)
|
|
function get_plurk_id transfer permalink to plurk_id
Parameters:
method get_public_profile [line 928]
JSON get_public_profile(
[int
$user_id = 0])
|
|
function get_public_profile
Tags:
Parameters:
method get_responses [line 835]
JSON get_responses(
[
$plurk_id = 0], [
$offset = 0], int
$plurk_id:, int
$offset:)
|
|
function get_responses
Tags:
Parameters:
method get_unread_plurks [line 574]
JSON get_unread_plurks(
[time
$offset = null], [int
$limit = 10])
|
|
function get_unread_plurks
Tags:
Parameters:
method get_user_info [line 1570]
function get_user_info Get user information
Tags:
method isLoggedIn [line 1605]
function isLoggedIn Compatible with RLPlurkAPI
Tags:
method log [line 110]
void log(
[$message
$message = NULL])
|
|
funciton log
Parameters:
method login [line 257]
boolean login(
[$api_key
$api_key = ''], [$username
$username = ''], [$password
$password = ''])
|
|
function login Login an already created user. Login creates a session cookie, which can be used to access the other methods.
Tags:
Parameters:
method logout [line 289]
function login Logout current user.
Tags:
method mark_plurk_as_read [line 771]
boolean mark_plurk_as_read(
$ids
$ids)
|
|
function mark_plurk_as_read
Tags:
Parameters:
method mutePlurk [line 1656]
bool mutePlurk(
array
$int_plurk_id, bool
$bool_setmute)
|
|
function mutePlurk Compatible with RLPlurkAPI Mute or unmute plurks
Tags:
Parameters:
method mute_plurks [line 686]
boolean mute_plurks(
$ids
$ids)
|
|
function mute_plurks
Tags:
Parameters:
method nicknameToUid [line 1876]
int nicknameToUid(
string
$string_nick_name)
|
|
function nicknameToUid Compatible with RLPlurkAPI Retrieve a user's uid from given his/her plurk nick name.
Tags:
Parameters:
method permalinkToPlurkID [line 1916]
int permalinkToPlurkID(
string
$string_permalink)
|
|
function permalinkToPlurkID Compatible with RLPlurkAPI Convert a plurk permalink URL address to a plurk ID.
Tags:
Parameters:
method plurk [line 131]
JSON plurk(
$url
$url, $array
$array)
|
|
function plurk Connect to Plurk
Tags:
Parameters:
method realtime_get_commet_channel [line 441]
JSON realtime_get_commet_channel(
[string
$comet_server = NULL], [string
$new_offset = NULL])
|
|
function realtime_get_commet_channel You'll get an URL from /API/Realtime/getUserChannel and you do GET requests to this URL to get new data. Your request will sleep for about 50 seconds before returning a response if there is no new data added to your channel. You won't get notifications on responses that the logged in user adds, but you will get notifications for new plurks.
Tags:
Parameters:
method realtime_get_user_channel [line 421]
JSON realtime_get_user_channel(
)
|
|
function realtime_get_user_channel Return's a JSON object with an URL that you should listen to, e.g. {"comet_server": "http://comet03.plurk.com/comet/1235515351741/?channel=generic-4-f733d8522327edf87b4d1651e6395a6cca0807a0", "channel_name": "generic-4-f733d8522327edf87b4d1651e6395a6cca0807a0"} for Comet channel specification: http://www.plurk.com/API#/API/Realtime/getUserChannel
Tags:
method register [line 219]
JSON register(
[string
$nick_name = NULL], [string
$full_name = NULL], [string
$password = ''], [string
$gender = 'male'], [string
$date_of_birth = '1985-05-13'], [
$email = NULL])
|
|
function register Register a new Plurk account. Should be HTTPS
Tags:
Parameters:
method remove_friend [line 1025]
boolean remove_friend(
[int
$friend_id = 0])
|
|
function remove_Friend
Tags:
Parameters:
method remove_from_clique [line 1516]
boolean remove_from_clique(
[string
$clique_name = ''], [int
$user_id = 0])
|
|
function remove_from_clique remove friend from clique
Tags:
Parameters:
method remove_notification [line 1243]
Boolean remove_notification(
[int
$user_id = 0])
|
|
function remove_notification Remove notification to user with id user_id.
Tags:
Parameters:
method rename_clique [line 1468]
boolean rename_clique(
[string
$clique_name = ''], [string
$new_name = ''])
|
|
function rename_clique rename clique
Tags:
Parameters:
method respondToPlurk [line 1724]
mixed respondToPlurk(
[int
$int_plurk_id = 0], [string
$string_lang = 'en'], [
$string_qualifie = 'says'], [string
$string_content = 'test from roga-plurk-api'], string
$string_qualifier)
|
|
function respondToPlurk Compatible with RLPlurkAPI Respond to a plurk.
Tags:
Parameters:
method search_plurk [line 1266]
JSON search_plurk(
[string
$query = ''], [int
$offset = 0])
|
|
function search_plurk Returns the latest 20 plurks on a search term.
Tags:
Parameters:
method search_user [line 1295]
JSON search_user(
[string
$query = ''], [int
$offset = 0])
|
|
function search_user Returns 10 users that match query, users are sorted by karma.
Tags:
Parameters:
method set_cookie_path [line 199]
void set_cookie_path(
[string
$cookie_path = NULL])
|
|
function set_cookie_path set curl cookie path
Parameters:
method set_following [line 1069]
boolean set_following(
[int
$user_id = 0], [boolean
$follow = false])
|
|
function set_following Update following of user_id. A user can befriend someone, but can unfollow them. This request is also used to stop following someone as a fan.
Tags:
Parameters:
method set_log_path [line 100]
void set_log_path(
[string
$log_path = NULL])
|
|
function set_log_path set log path
Parameters:
method set_proxy [line 184]
void set_proxy(
[string
$host = ''], [string
$port = 0], [string
$username = ''], [string
$password = ''])
|
|
function set_proxy Set proxy server options while connecting to Plurk API
Parameters:
method uidToNickname [line 1862]
string uidToNickname(
int
$uid)
|
|
function uidToNickname Compatible with RLPlurkAPI Translates a uid to the corresponding nickname.
Tags:
Parameters:
method uidToUserinfo [line 1890]
array uidToUserinfo(
int
$int_uid)
|
|
function uidToUserinfo Compatible with RLPlurkAPI Retrieve a user's information given a plurk uid.
Tags:
Parameters:
method unblockUser [line 1836]
bool unblockUser(
[array
$array_uid = null])
|
|
function unblockUser Compatible with RLPlurkAPI
Tags:
Parameters:
method unblock_user [line 1382]
boolean unblock_user(
[user_id:
$user_id = 0])
|
|
function unblock_user
Tags:
Parameters:
method unfavorite_plurk [line 750]
boolean unfavorite_plurk(
$ids
$ids)
|
|
function unfavorite_plurk
Tags:
Parameters:
method unmute_plurks [line 708]
boolean unmute_plurks(
$ids
$ids)
|
|
function unmute_plurks
Tags:
Parameters:
method update [line 316]
boolean update(
[string
$current_password = NULL], [string
$full_name = NULL], [string
$new_password = NULL], [string
$email = NULL], [string
$display_name = NULL], [string
$privacy = NULL], [string
$date_of_birth = NULL])
|
|
function update Update a user's information (such as email, password or privacy). Should be HTTPS
Tags:
Parameters:
method update_picture [line 354]
JSON update_picture(
[string
$profile_image = ''])
|
|
function update_picture update a user's profile picture. You can read more about how to render an avatar via user data.
Tags:
Parameters:
method upload_picture [line 796]
JSON upload_picture(
[string
$upload_image = ''])
|
|
function upload_picture to upload a picture to Plurk, you should do a multipart/form-data POST request to /API/Timeline/uploadPicture. This will add the picture to Plurk's CDN network and return a image link that you can add to /API/Timeline/plurkAdd
Tags:
Parameters:
|
|