Difference between revisions of "GetSocialFollowers"

Latest revision as of 22:52, 13 December 2011

Get a list of users who are following a resource.

Syntax

CollectionsBean followers;
followers = Functions.getSocialFollowers(String type, String id, String objectId, String criteria);

Parameters

type: A string containing one of the Relay Feed Types. (required)
id: The ID of the feed. (required)
objectId: Required if the feed type is "record". Otherwise, it can be an empty string.
criteria: An optional filter expression that specifies records to select. Otherwise, it can be an empty string.

Returns: A CollectionBean containing the SocialUserBean objects for users who are following the resource.

@@ Line 5: / Line 5: @@
 :<syntaxhighlight lang="java" enclose="div">
 CollectionsBean followers;
-followers = Functions.getSocialFollowers(String type, String id, String objectId, String filter);
+followers = Functions.getSocialFollowers(String type, String id, String objectId, String criteria);
 </syntaxhighlight>
 ;Parameters:
-* For list of type, see relay type table in the link (to REST table) in the spec
+:;type: A string containing one of the Relay [[REST_API:social_feed_Resource#Feed_Types|Feed Types]]. (required)
-* type and id are required.
+:;id: The ID of the feed. (required)
-* Filter is optional.
+:;objectId: Required if the feed type is "record". Otherwise, it can be an empty string.
-* ObjectId is required if the type is Record.
+:;criteria:An optional [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select. Otherwise, it can be an empty string.
-:;objectName:The object name or identifier
-:;fields:A comma-separated list of names of the fields to retrieve
-:;criteria:A [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select.
-:;params: An optional [[Parameters Class|Parameters]] object that contains additional parameters:
-:::*''' param -''' ...
 ;Returns: