Changes: API BNGetFOFInfo

Revision as of 02:29, 26 August 2021

Returns information about the specified friend of a RealID friend

friendID, accountName, isMutual = BNGetFOFInfo(mutual, nonMutual, index)

Arguments

mutual: boolean - Should the list include mutual friends (I.e. people who you and the person referenced by presenceID are both friends with).
nonMutual: boolean - Should the list include non-mutual friends.
index: number - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...))

Returns

friendID: number - a unique numeric identifier for this friend for this session
accountName: string - a Kstring representing the friend's name (As of 4.0)
isMutual: boolean - true if this person is a direct friend of yours, false otherwise.

@@ Line 1: / Line 1: @@
-{{wowapi}} __NOTOC__
+{{wowapi}}
 Returns information about the specified friend of a RealID friend
- presenceID, givenName, surname, isFriend = BNGetFOFInfo(presenceID, mutual, nonMutual, index)
+ friendID, accountName, isMutual = BNGetFOFInfo(mutual, nonMutual, index)
 == Arguments ==
+;mutual : <span class="apitype">boolean</span> - Should the list include mutual friends (I.e. people who you and the person referenced by presenceID are both friends with).
-; 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).
+;nonMutual : <span class="apitype">boolean</span> - Should the list include non-mutual friends.
+;index : <span class="apitype">number</span> - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...))
-; nonMutual : Boolean - Should the list include non-mutual friends.
-; index : number - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...))
 == Returns ==
+;friendID : <span class="apitype">number</span> - a unique numeric identifier for this friend for this session
-:presenceID, givenName, surname, isFriend
+;accountName : <span class="apitype">string</span> - a [[Kstring]] representing the friend's name (As of 4.0)
-;presenceID : Number - a unique numeric identifier for this friend for this session
+;isMutual : <span class="apitype">boolean</span> - true if this person is a direct friend of yours, false otherwise.
-;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/Family name (As of 4.0)
-;isFriend : Boolean - true if this person is a direct friend of yours, false otherwise.