LongJump Support Wiki

Difference between revisions of "GetSocialFollowers"

From LongJump Support Wiki
imported>Aeric
(Created page with "{{subst: Java API}}")
 
imported>Aeric
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:__apiName__}}
{{DISPLAYTITLE:getSocialFollowers}}
Description...
Get a list of users who are following a resource.


;Syntax:
;Syntax:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
Result result = Functions.__apiName__(String objectName, String fields, String criteria);  
CollectionsBean followers;
Result result = Functions.__apiName__(String objectName, String fields, String criteria
followers = Functions.getSocialFollowers(String type, String id, String objectId, String criteria);  
                            [, Parameters params] );
Result result = Functions.__apiName__(String objectName, String fields, String criteria);
Result result = Functions.__apiName__(String objectName, String fields, String criteria,
                            String sortBy, String sortOrder,
                            String sortBy2, String sortOrder2,
                            int offset, int numberOfRows);
</syntaxhighlight>
</syntaxhighlight>


;Parameters:
;Parameters:
:;objectName:The object name or identifier
:;type: A string containing one of the Relay [[REST_API:social_feed_Resource#Feed_Types|Feed Types]]. (required)
:;fields:A comma-separated list of names of the fields to retrieve
:;id: The ID of the feed. (required)
:;criteria:A [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select.
:;objectId: Required if the feed type is "record". Otherwise, it can be an empty string.
:;params: An optional [[Parameters Class|Parameters]] object that contains additional parameters:
:;criteria:An optional [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select. Otherwise, it can be an empty string.
:::*''' param -''' ...


;Returns:
;Returns:
:[[Result Class|<tt>Result</tt>]] object<br/>
:A [{{DOCHOST}}/javadocs/com/platform/beans/CollectionBean.html <tt>CollectionBean</tt>] containing the [{{DOCHOST}}/javadocs/com/platform/beans/SocialUserBean.html SocialUserBean] objects for users who are following the resource.
--or--
:An integer containing ...
:A string containing ...


;Throws:
;Throws:
:Exception
:Exception
;Example:This example ....
:<syntaxhighlight lang="java" enclose="div">
...
</syntaxhighlight>
<!--ACTIVATE THE CATEGORY BELOW
<noinclude>
[[Category:Java API | __apiName__]]
</noinclude>
-->

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.
Throws
Exception
Retrieved from "https://agileappscloud.info/ljwiki-src/index.php?title=GetSocialFollowers&oldid=11941"