ljr/livejournal/doc/raw/int/protocol/getfriends.mode.xml

41 lines
1.6 KiB
XML
Raw Normal View History

2019-02-05 21:49:12 +00:00
<method name="getfriends">
<shortdes>
Returns a list of which other LiveJournal users this user lists as their friend.
</shortdes>
<des>
Returns a verbose list of information on friends a user has listed. Optionally able to include their friends of list, the friends group associated with each user, and a limit on the number of friends to return.
</des>
<arguments><struct count="1">
&authInfo;
<key name="includefriendof" count="opt"><scalar><des>
If set to 1, you will also get back the info from the "friendof" mode. Some clients show friends and friendof data in separate tabs/panes. If you're always going to load both, then use this flag (as opposed to a tabbed dialog approach, where the user may not go to the second tab and thus would not need to load the friendof data.) friendof request variables can be used.
</des></scalar></key>
<key name="includegroups" count="opt"><scalar><des>
If set to 1, you will also get back the info from the "getfriendgroups" mode. See above for the reason why this would be useful.
</des></scalar></key>
<key name="friendlimit" count="opt"><scalar><des>
If set to a numeric value greater than zero, this mode will only return the number of results indicated. Useful only for building pretty lists for display which might have a button to view the full list nearby.
</des></scalar></key>
</struct></arguments>
<!--===================[ RETURN ]==============================-->
<returns><struct count="1">
&friendGroups;
<key name="friendofs">
&friendsList;
</key>
<key name="friends">
&friendsList;
</key>
</struct></returns>
</method>