Feed.publishActionOfUser

From Facebook Developers Wiki

Jump to: navigation, search

Contents

[edit] Description

Publishes a Mini-Feed story to the user corresponding to the session_key parameter, and publishes News Feed stories to the friends of that user who have added the application.


[edit] Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application.
session_key string The session key of the logged in user.
call_id float The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function.
sig string An MD5 hash of the current request and your secret key, as described in the authentication guide.
v string This must be set to 1.0 to use this version of the API.
title markup The markup displayed in the feed story's title section.
optional format string Desired response format. Either XML (default) or JSON.
callback string Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.
body markup The markup displayed in the feed story's body section.
image_1 string The URL of an image to be displayed in the News Feed story.
image_1_link string The URL destination after a click on the image referenced by image_1.
image_2 string The URL of an image to be displayed in the News Feed story.
image_2_link string The URL destination after a click on the image referenced by image_2.
image_3 string The URL of an image to be displayed in the News Feed story.
image_3_link string The URL destination after a click on the image referenced by image_3.
image_4 string The URL of an image to be displayed in the News Feed story.
image_4_link string The URL destination after a click on the image referenced by image_4.


[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <feed_publishActionOfUser_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd"> 1 </feed_publishActionOfUser_response>


[edit] Response

The function returns 1 on success, 0 on permissions error, or an error response.

[edit] Notes

Publishing to Feeds requires you to understand the rules of their operation.

  • The title is required, and is limited to 60 displayed characters (excluding tags).
    • One <a> tag is allowed.
    • One fb:userlink tag is allowed, and the uid parameter must be populated with the user ID on whose behalf the action is being published. If there is no such fb:userlink tag found, then one is automatically prepended to the title.
    • The fb:name tag is allowed, and there may be multiple instances of this tag.
    • No other tags are allowed.
  • The body is optional, is limited to 200 display characters (excluding tags), and can include the tags fb:userlink, fb:name, <a>, <b>, and <i>.
  • Up to 4 images can be displayed, which will be shrunk to fit within 75x75, cached, and formatted by Facebook. Images can either be a URL, or a Facebook PID. (RobRoy: PID doesn't work for me, anyone else verify?) If it is a URL, you must own the image and grant Facebook the permission to cache it. Each image must have a link associated with it, which must start with http://
  • Applications are limited to calling this function 10 times for each user in a rolling 48-hour window.
  • The story may or may not show up in the user's friends' News Feeds, depending on the number and quality of competing stories.
  • The word "message" is disallowed in a feed story. Attempting to publish a story with the word "message" will result in an error being returned.
  • Developer Note: Since this method affects all Facebook friends of the developer, testing this method does abide by the limited-calling rule (unlike feed.publishStoryToUser).


[edit] Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
100 One of the parameters specified was missing or invalid.
101 The API key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.
343 Feed story title is too long.
345 Feed story title rendered as blank.


[edit] See Also

  • You can see a real world example of this method in the Footprints and Restaurants demo applications. Go to Demos for more details and to download and install the demo apps.


[edit] Behavior Summary

publishActionOfUser
Publishes to minifeed Yes
Publishes to newsfeed Friends' (possibly)
Prefix The user's name is a prefix to the title

(if you don't specify <fb:userlink>)

Tags Allowed in Title fb:userlink, fb:name, fb:pronoun, a
*the 'a' and 'fb:userlink' tags can be used a maximum of once each in the title
Tags Allowed in Body fb:userlink, fb:name, a, b, i
Navigation