На главную

Метод Friends.Get

Возвращает список идентификаторов друзей пользователя или расширенную информацию о друзьях пользователя (при использовании параметра fields).

Этот метод можно вызвать с сервисным ключом доступа. Возвращаются только общедоступные данные.

Этот метод можно вызвать с ключом доступа пользователя.

Страница документации ВКонтакте friends.get.

Синтаксис

public VkCollection<User> Get(FriendsGetParams @params, bool skipAuthorization = false)

Параметры

Класс FriendsGetParams содержит следующие свойства:

• user_id — идентификатор пользователя, для которого необходимо получить список друзей. Если параметр не задан, то считается, что он равен идентификатору текущего пользователя (справедливо для вызова с передачей access_token).
• order — порядок, в котором нужно вернуть список друзей. Допустимые значения:
  • hints — сортировать по рейтингу, аналогично тому, как друзья сортируются в разделе Мои друзья (Это значение доступно только для Standalone-приложений с ключом доступа, полученным по схеме Implicit Flow.).
  • random — возвращает друзей в случайном порядке.
  • mobile — возвращает выше тех друзей, у которых установлены мобильные приложения.
  • name — сортировать по имени. Данный тип сортировки работает медленно, так как сервер будет получать всех друзей а не только указанное количество count. (работает только при переданном параметре fields). По умолчанию список сортируется в порядке возрастания идентификаторов пользователей.
• list_id — идентификатор списка друзей, полученный методом friends.getLists, друзей из которого необходимо получить. Данный параметр учитывается, только когда параметр user_id равен идентификатору текущего пользователя. Этот параметр доступен только для Standalone-приложений с ключом доступа, полученным по схеме Implicit Flow.
• count — количество друзей, которое нужно вернуть.
• offset — смещение, необходимое для выборки определенного подмножества друзей.
• fields — список дополнительных полей, которые необходимо вернуть. Доступные значения: nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities.
• name_case — Падеж для склонения имени и фамилии пользователя. Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom. строка.
• ref — строка, максимальная длина 255.

Результат

После успешного выполнения возвращает список идентификаторов (id) друзей пользователя, если параметр fields не использовался. При использовании параметра fields возвращает список объектов пользователей, но не более 5000.

Исключения

• 30 - This profile is private.
• В ходе выполнения могут произойти общие ошибки. Их описание находится на отдельной странице.

Пример

// Получение идентификаторов друзей Павла Дурова.
var users = api.Friends.Get(new VkNet.Model.RequestParams.FriendsGetParams
{
    UserId = 1,
    Count = 10, 
});

using VkNet.Enums.Filters;

// Получение идентификаторов, имен и фамилий первых трех друзей Павла Дурова.
var users = api.Friends.Get(new VkNet.Model.RequestParams.FriendsGetParams
{
    UserId = 1,
    Count = 10,
    Fields = ProfileFields.FirstName,
});

// Получить имена друзей
var p = users.Select(x => x.FirstName);
foreach(var item in p)
{
    //logic   
}

// Получить фамилии друзей
var p = users.Select(x => x.LastName);
foreach(var item in p)
{
    //logic
}

// Получить друзей онлайн
var p = users.Select(x => x.Online);
foreach(var item in p)
{
    //logic
}

Версия Вконтакте API v.5.103

Дата обновления: 17.01.2020 16:21.