@datafire/skyrock

Client library for Skyrock

Installation and Usage

npm install --save @datafire/skyrock

let skyrock = require('@datafire/skyrock').create();

.then(data => {
  console.log(data);
});

Description

Interact with Skyrock.com features: blogs, profiles, messaging, 'what's new', friends & activities!

Actions

message.reply_thread.format.post

Replies to a thread.

skyrock.message.reply_thread.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.create_thread.format.post

Creates a multi-recipient thread.

skyrock.message.create_thread.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.send_message.format.post

Sends a message to a single recipient.

skyrock.message.send_message.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.delete_message.format.post

Deletes a message.

skyrock.message.delete_message.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.delete_thread.format.post

Deletes a message thread.

skyrock.message.delete_thread.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.set_thread_as_read.format.post

Marks a message thread as read.

skyrock.message.set_thread_as_read.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

message.get_thread.format.get

Returns a message thread (15 messages per page).

skyrock.message.get_thread.format.get({
  "format": "",
  "id_thread": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_thread required integer: Message thread ID.
  • page integer: Page number (optional).

Output

Output schema unknown

message.list_threads.format.get

Returns the authenticated user's message threads (15 threads per page).

skyrock.message.list_threads.format.get({
  "format": "",
  "filter": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • filter required string (values: all, unread): Thread selection filter (all/unread).
  • page integer: Page number (optional).

Output

Output schema unknown

newsfeed.list_alerts_types.format.get

Returns descriptions of alerts types, for developer information.

skyrock.newsfeed.list_alerts_types.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

newsfeed.list_alerts.format.get

Lists user's alerts (notifications).

skyrock.newsfeed.list_alerts.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

newsfeed.list_events_types.format.get

Returns descriptions of events types, for developer information.

skyrock.newsfeed.list_events_types.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

newsfeed.list_events.format.get

Lists events in the user's dash-board (eg. newsfeed).

skyrock.newsfeed.list_events.format.get({
  "format": "",
  "events_category": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • events_category required string (values: own, friends): Events category. Possible values: own (display own events), friends (display friends' events).

Output

Output schema unknown

newsfeed.send_alert.format.post

Sends a free text as alert to the authenticated user's alerts (notifications). The message is not localized and should be send in the user language. Unlike events, alerts are personal.

skyrock.newsfeed.send_alert.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

newsfeed.send_event.format.post

Sends a free text as event to the authenticated user's dash-board (eg. newsfeed). Events also appear in the dash-board of the user's friends. The message is not localized and should be send in the user language.

skyrock.newsfeed.send_event.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

mood.delete_mood.format.post

Deletes an user's mood.

skyrock.mood.delete_mood.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

mood.set_mood.format.post

Sets an user's mood.

skyrock.mood.set_mood.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

mood.get_mood.format.get

Returns an user last mood.

skyrock.mood.get_mood.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

mood.list_moods.format.get

Returns an user's mood list.

skyrock.mood.list_moods.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

profile.get_tags_types.format.get

Returns user profile's tags types.

skyrock.profile.get_tags_types.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.get_tags.format.get

Returns an user profile's tags.

skyrock.profile.get_tags.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

profile.set_tags.format.post

Sets an user profile's tags.

skyrock.profile.set_tags.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.get_property_values.format.get

Returns possible values for a given property. These properties can be set using set or set_config.

skyrock.profile.get_property_values.format.get({
  "format": "",
  "property": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • property required string (values: gender, gender_preference, looks_for, status, town, country, department, occupation, place, personality, smoker, hair_color, eye_color, height, weight, block_friends, block_honors, block_groups, block_gifts, show_visits_counter, show_comments_counter, show_kiffs_counter, show_my_websites, show_mood, display_policy, allow_share, allow_facebook_like, allow_votes, allow_kiffs, default_page, show_me_page, show_news_page, show_photos_page, show_videos_page, allow_comments): Property name. Possible values: gender, gender_preference, looks_for, status, town, country, department, occupation, place, personality, smoker, hair_color, eye_color, height, weight, block_friends, block_honors, block_groups, block_gifts, show_visits_counter, show_comments_counter, show_kiffs_counter, show_my_websites, show_mood, display_policy, allow_share, allow_facebook_like, allow_votes, allow_kiffs, default_page, show_me_page, show_news_page, show_photos_page, show_videos_page, allow_comments.

Output

Output schema unknown

profile.set_config.format.post

Sets informations about a profile's (see get_property_values for possible values to set).

skyrock.profile.set_config.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.get_config.format.get

Returns settings about current user's profile.

skyrock.profile.get_config.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.delete_picture.format.post

Deletes a picture.

skyrock.profile.delete_picture.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.set_picture.format.post

Sets a picture's properties.

skyrock.profile.set_picture.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.get_picture.format.get

Returns a specified picture.

skyrock.profile.get_picture.format.get({
  "format": "",
  "id_album": 0,
  "id_picture": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_album required integer: Album ID.
  • id_picture required integer: Picture ID.

Output

Output schema unknown

profile.list_pictures.format.get

Returns the list of pictures associated with a profile.

skyrock.profile.list_pictures.format.get({
  "format": "",
  "id_album": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • id_album required integer: Album ID.

Output

Output schema unknown

profile.add_picture.format.post

Adds a picture to the profile.

skyrock.profile.add_picture.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.delete_album.format.post

Deletes an empty album. Main album (id_album = 1) cannot be deleted.

skyrock.profile.delete_album.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.set_album.format.post

Sets an album's title.

skyrock.profile.set_album.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.list_albums.format.get

Returns the list of albums associated with a profile. Main album has id_album = 1.

skyrock.profile.list_albums.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

profile.add_album.format.post

Adds an album to the profile.

skyrock.profile.add_album.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.set.format.post

Sets an user's profile public data.

skyrock.profile.set.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

profile.get.format.get

Returns an user's profile public data.

skyrock.profile.get.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • output_format string (values: html, bbcode): Defines which format to output, for specific rich text fields. Possible values: 'html' (default), 'bbcode'.

Output

Output schema unknown

blog.list_pictures.format.get

Returns the list of pictures from all blog's articles, paginated (35 pictures per page).

skyrock.blog.list_pictures.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • page integer: Page number.

Output

Output schema unknown

blog.list_skins.format.get

Returns available skins.

skyrock.blog.list_skins.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.get_post_comment.format.get

Returns a post's comment.

skyrock.blog.get_post_comment.format.get({
  "format": "",
  "id_post": 0,
  "id_comment": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • id_post required integer: Post ID.
  • id_comment required integer: Post comment ID.

Output

Output schema unknown

blog.list_post_comments.format.get

Lists a post's comments.

skyrock.blog.list_post_comments.format.get({
  "format": "",
  "id_post": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • id_post required integer: Post ID.
  • page integer: Page number.

Output

Output schema unknown

blog.delete_post_media.format.post

Deletes a post's media.

skyrock.blog.delete_post_media.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.new_post_media.format.post

Associates media with a blog post.

skyrock.blog.new_post_media.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.list_post_medias.format.get

Returns a post's medias list.

skyrock.blog.list_post_medias.format.get({
  "format": "",
  "id_post": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • id_post required integer: Post ID.

Output

Output schema unknown

blog.delete_post.format.post

Deletes a blog post.

skyrock.blog.delete_post.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.set_post.format.post

Edits a blog post.

skyrock.blog.set_post.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.get_post.format.get

Returns an user's blog post. Only online posts will be returned, unless authenticated user is its creator.

skyrock.blog.get_post.format.get({
  "format": "",
  "id_post": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • id_post required integer: Post ID.
  • output_format string (values: html, bbcode): Defines which format to output, for specific rich text fields. Possible values: 'html' (default), 'bbcode'.

Output

Output schema unknown

blog.new_post.format.post

Creates a new blog post.

skyrock.blog.new_post.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.list_offline_posts.format.get

Returns current user's blog posts list (offline only), paginated.

skyrock.blog.list_offline_posts.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • page integer: Page number.
  • with_secret boolean: Allow authenticated blog owner to show secret posts (false by default).
  • output_format string (values: html, bbcode): Defines which format to output, for specific rich text fields. Possible values: 'html' (default), 'bbcode'.

Output

Output schema unknown

blog.list_posts.format.get

Returns an user's blog posts list (online only), paginated (10 articles per page).

skyrock.blog.list_posts.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • page integer: Page number.
  • with_secret boolean: Allow authenticated blog owner to show secret posts (false by default).
  • output_format string (values: html, bbcode): Defines which format to output, for specific rich text fields. Possible values: 'html' (default), 'bbcode'.

Output

Output schema unknown

blog.change_avatar.format.post

Changes authenticated user's blog avatar.

skyrock.blog.change_avatar.format.post({
  "format": "",
  "Content-Type": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • Content-Type required string: Content type.

Output

Output schema unknown

blog.set.format.post

Sets authenticated user's blog data. Each parameter is optional, you can either set one or many at once.

skyrock.blog.set.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

blog.get.format.get

Returns a blog public data. If the call is authenticated and username is not provided, the method returns data about the current user's Skyrock blog.

skyrock.blog.get.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • output_format string (values: html, bbcode): Defines which format to output, for specific rich text fields. Possible values: 'html' (default), 'bbcode'.

Output

Output schema unknown

user.list_groups.format.get

List of user's groups.

skyrock.user.list_groups.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

user.remove_user_from_blacklist.format.post

Removes a user from the blacklist.

skyrock.user.remove_user_from_blacklist.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.add_user_to_blacklist.format.post

Adds a user to the blacklist.

skyrock.user.add_user_to_blacklist.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.list_blacklist.format.get

List of users in blacklist.

skyrock.user.list_blacklist.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.get_counters.format.get

Returns current user counters.

skyrock.user.get_counters.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.is_friend.format.get

Checks friend relation between two users.

skyrock.user.is_friend.format.get({
  "format": "",
  "id_user_1": 0,
  "id_user_2": 0
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user_1 required integer: First user ID.
  • id_user_2 required integer: Second user ID.

Output

Output schema unknown

user.deny_friend_request.format.post

Denies a friend request.

skyrock.user.deny_friend_request.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.accept_friend_request.format.post

Accepts a friend request.

skyrock.user.accept_friend_request.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.list_friend_requests.format.get

List of friend requests.

skyrock.user.list_friend_requests.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.remove_from_friends.format.post

Removes a friend from the friend list.

skyrock.user.remove_from_friends.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.remove_from_best_friends.format.post

Removes a friend from the best friend list. The friend user should be a best friend of current user.

skyrock.user.remove_from_best_friends.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.add_to_best_friends.format.post

Adds a friend to the best friend list. The friend user should be a friend of current user.

skyrock.user.add_to_best_friends.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.send_friend_request.format.post

Sends a friend request.

skyrock.user.send_friend_request.format.post({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

user.list_online_friends.format.get

List of online friends.

skyrock.user.list_online_friends.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

user.list_best_friends.format.get

List of best friends (paginated).

skyrock.user.list_best_friends.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • page integer: Page number.
  • order string: Results order. Possible values:

Output

Output schema unknown

user.list_friends_ids.format.get

List of friends ids (paginated).

skyrock.user.list_friends_ids.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • page integer: Page number.
  • order string: Results order. Possible values:

Output

Output schema unknown

user.list_friends.format.get

List of friends (paginated).

skyrock.user.list_friends.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).
  • page integer: Page number.
  • order string: Results order. Possible values:

Output

Output schema unknown

user.get.format.get

Returns an user's public data. If the call is authenticated and username is not provided, the method returns data about the current user's Skyrock account.

skyrock.user.get.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.
  • id_user integer: User ID (optional if OAuthenticated).
  • username string: Username (optional if OAuthenticated).

Output

Output schema unknown

check_rate_limit.format.get

Returns the number of remaining queries (see http://en.skyrock.com/developer/documentation/api/#request-rate-limits). Calls to this method are not counted against the limits.

skyrock.check_rate_limit.format.get({
  "format": ""
}, context)

Input

• input object
  • format required string (values: json, xml): Response format.

Output

Output schema unknown

Definitions

This integration has no definitions