WoW API: BNGetFOFInfo

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < BNGetFOFInfo

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.