На главную

Метод Groups.Search

Осуществляет поиск сообществ по заданной подстроке.

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

Синтаксис

public ReadOnlyCollection<Group> Search(out int totalCount, GroupsSearchParams @params)

Параметры

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

• Q - Текст поискового запроса. строка, обязательный параметр
• Type - Тип сообщества. Возможные значения: group, page, event. строка
• CountryId - Идентификатор страны. положительное число
• CityId - Идентификатор города. При передаче этого параметра поле country_id игнорируется. положительное число
• Future - При передаче значения 1 будут выведены предстоящие события. Учитывается только при передаче в качестве type значения event. флаг, может принимать значения 1 или 0
• Sort - 0 — сортировать по умолчанию (аналогично результатам поиска в полной версии сайта); 1 — сортировать по скорости роста; 2 — сортировать по отношению дневной посещаемости к количеству пользователей; 3 — сортировать по отношению количества лайков к количеству пользователей; 4 — сортировать по отношению количества комментариев к количеству пользователей; 5 — сортировать по отношению количества записей в обсуждениях к количеству пользователей. целое число
• Offset - Смещение, необходимое для выборки определённого подмножества результатов поиска. По умолчанию — 0. положительное число
• Count - Количество результатов поиска, которое необходимо вернуть. Обратите внимание — даже при использовании параметра offset для получения информации доступны только первые 1000 результатов. положительное число, по умолчанию 20, максимальное значение 1000

Результат

После успешного выполнения возвращает список объектов group.

Исключения

• AccessTokenInvalidException - не задан или используется неверный AccessToken.
• InvalidParamException - Поисковый запрос не пуст или равен значению null.

Пример

// Поиск групп по запросу "Music".
int totalCount;
var groups = vk.Groups.Search(out totalCount, new GroupsSearchParams {Query = "Music"});

// Поиск трех групп, начиная с двадцатой, удовлетворяющих запросу "Music".
int totalCount;
var groups = vk.Groups.Search(out totalCount, new GroupsSearchParams {Query = "Music", Offset = 20, Count = 3});

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

Дата обновления: 19.01.2016 16:15:07