(Created page) |
(clarified mutual, corrected mistake in Surname description) |
||
| Line 5: | Line 5: | ||
== Arguments == |
== Arguments == |
||
;presenceID : number - The presenceID for the RealID friend for whom you are requesting friend info. |
;presenceID : number - The presenceID for the RealID friend for whom you are requesting friend info. |
||
| − | ;mutual : Boolean - Should the list include mutual friends. |
+ | ;mutual : Boolean - Should the list include mutual friends (I.e. people who you and the person referenced by presenceID are both friends with). |
;non-mutual : Boolean - Should the list include non-mutual friends. |
;non-mutual : Boolean - Should the list include non-mutual friends. |
||
;index : number - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...)) |
;index : number - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...)) |
||
| Line 13: | Line 13: | ||
;presenceID : Number - a unique numeric identifier for this friend for this session |
;presenceID : Number - a unique numeric identifier for this friend for this session |
||
;givenName : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's first/given name (As of 4.0) |
;givenName : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's first/given name (As of 4.0) |
||
| − | ;surname : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's |
+ | ;surname : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's Surname/Family name (As of 4.0) |
;isFriend : Boolean - true if this person is a direct friend of yours, false otherwise. |
;isFriend : Boolean - true if this person is a direct friend of yours, false otherwise. |
||
Revision as of 14:05, 15 October 2010
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns information about the specified friend of a RealID friend
presenceID, givenName, surname, isFriend = BNGetFOFInfo(presenceID, mutual, non-mutual, index)
Arguments
- presenceID
- number - The presenceID for the RealID friend for whom you are requesting friend info.
- mutual
- Boolean - Should the list include mutual friends (I.e. people who you and the person referenced by presenceID are both friends with).
- non-mutual
- Boolean - Should the list include non-mutual friends.
- index
- number - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...))
Returns
- presenceID, givenName, surname, isFriend
- presenceID
- Number - a unique numeric identifier for this friend for this session
- givenName
- String - a |K Escape Sequence representing the friend's first/given name (As of 4.0)
- surname
- String - a |K Escape Sequence representing the friend's Surname/Family name (As of 4.0)
- isFriend
- Boolean - true if this person is a direct friend of yours, false otherwise.