LJ.XMLRPC.getfriends
Returns a detailed list of the friends associated with the authenticated user's account.
Request Parameters
- LiveJournal's Common Request Parameters
- includefriendof - 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. (optional)
- includegroups - 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. (optional)
- friendlimit - 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. (optional)
Return Values
A struct containing the following keys:
- friendgroups - An array of struct of type FriendGroups.
- friendofs - An array of struct of type FriendsOf.
- friends - An array of struct of type Friend.
FriendsGroup Struct
Contains the following keys:
- id - The bit number for this friend group, from 1-30.
- name - The name of this friend group.
- sortorder - The sort integer for this friend group, from 0-255.
- public - Either '0' or '1' for if this friend group is public.
FriendsOf Struct
Contains the following keys:
- username - The username of the friend.
- fullname - The full name of the friend.
- type - The type of journal the friend item is. This value can be one of 'community', 'syndicated', 'news', or 'shared', depending on the journaltype of the account in question. The account is a normal personal account when this value is not sent.
- fgcolor - The foreground color of the friend item.
- bgcolor - The background color of the friend item.
- groupmask - If the group mask is not "1" (just bit 0 set), then this variable is returned with an 32-bit unsigned integer with a bit 0 always set, and bits 1-30 set for each group this friend is a part of. Bit 31 is reserved.
Friend Struct
Contains the following keys:
- username - The username of the friend.
- fullname - The full name of the friend.
- type - The type of journal the friend item is. This value can be one of 'community', 'syndicated', 'news', or 'shared', depending on the journaltype of the account in question. The account is a normal personal account when this value is not sent.
- fgcolor - The foreground color of the friend item.
- bgcolor - The background color of the friend item.
- groupmask - If the group mask is not "1" (just bit 0 set), then this variable is returned with an 32-bit unsigned integer with a bit 0 always set, and bits 1-30 set for each group this friend is a part of. Bit 31 is reserved.
