getFriends {vkR}R Documentation

Returns a list of user IDs or detailed information about a user's friends

Description

Returns a list of user IDs or detailed information about a user's friends

Usage

getFriends(
  user_id = "",
  order = "",
  list_id = "",
  count = "",
  offset = "",
  fields = "",
  name_case = "",
  flatten = FALSE,
  v = getAPIVersion()
)

Arguments

user_id

User ID. By default, the current user ID

order

Sort order (name - by name, hints - by rating)

list_id

ID of the friend list returned by the friends.getLists method to be used as the source. This parameter is taken into account only when the uid parameter is set to the current user ID

count

Number of friends to return

offset

Offset needed to return a specific subset of friends

fields

Profile fields to return

name_case

Case for declension of user name and surname

flatten

Automatically flatten nested data frames into a single non-nested data frame

v

Version of API

Examples

## Not run: 
friends_list <- getFriends(user_id=1, order='name', fields='bdate')
friends <- friends_list$items

## End(Not run)

[Package vkR version 0.2 Index]