C# Class VkNet.Categories.GroupsCategory

Методы для работы с сообществами (группами).

Afficher le fichier Open project: vknet/vk Class Usage Examples

Méthodes publiques

Méthode	Description
AddLink ( long groupId, Uri link, string text ) : Link	Позволяет добавлять ссылки в сообщество. Страница документации ВКонтакте .
ApproveRequest ( long groupId, long userId ) : bool	Позволяет одобрить заявку в группу от пользователя. Страница документации ВКонтакте .
BanUser ( GroupsBanUserParams @params ) : bool	Добавляет пользователя в черный список сообщества. Страница документации ВКонтакте .
Create ( string title, string description, GroupType type, GroupSubType subtype ) : Model.Group	Создает новое сообщество. Страница документации ВКонтакте .
DeleteLink ( long groupId, ulong linkId ) : bool	Позволяет удалить ссылки из сообщества. Страница документации ВКонтакте .
Edit ( GroupsEditParams @params ) : bool	Редактирует сообщество. Страница документации ВКонтакте .
EditLink ( long groupId, ulong linkId, string text ) : bool	Позволяет редактировать ссылки в сообществе. Страница документации ВКонтакте .
EditManager ( GroupsEditManagerParams @params ) : bool	Позволяет назначить/разжаловать руководителя в сообществе или изменить уровень его полномочий. Страница документации ВКонтакте .
EditPlace ( long groupId, Model.Place place = null ) : bool	Позволяет редактировать информацию о месте группы. Для удаления информации о местоположении нужно передать только group_id. Для обновления данных о местоположении необходимо указать как минимум id страны, широту и долготу. Для того, чтобы воспользоваться этим методом Вы должны быть администратором группы. Страница документации ВКонтакте .
Get ( GroupsGetParams @params, bool skipAuthorization = false ) : VkCollection	Возвращает список сообществ указанного пользователя. Страница документации ВКонтакте .
GetBanned ( long groupId, long offset = null, long count = null, GroupsFields fields = null, long userId = null ) : VkCollection	Возвращает список забаненных пользователей в сообществе. Страница документации ВКонтакте .
GetById ( IEnumerable groupIds, string groupId, GroupsFields fields, bool skipAuthorization = false ) : ReadOnlyCollection	Возвращает информацию о заданном сообществе или о нескольких сообществах. Страница документации ВКонтакте .
GetCatalog ( ulong categoryId = null, ulong subcategoryId = null ) : VkCollection	Возвращает список сообществ выбранной категории каталога. Страница документации ВКонтакте .
GetCatalogInfo ( bool extended = null, bool subcategories = null ) : GroupsCatalogInfo	Возвращает список категорий для каталога сообществ. Страница документации ВКонтакте .
GetInvitedUsers ( long groupId, long offset = null, long count = null, UsersFields fields = null, NameCase nameCase = null ) : VkCollection	Возвращает список пользователей, которые были приглашены в группу. Страница документации ВКонтакте .
GetInvites ( long count, long offset, bool extended = null ) : VkCollection	Данный метод возвращает список приглашений в сообщества и встречи текущего пользователя. Страница документации ВКонтакте .
GetMembers ( GroupsGetMembersParams @params, bool skipAuthorization = false ) : VkCollection	Возвращает список участников сообщества. Страница документации ВКонтакте .
GetRequests ( long groupId, long offset, long count, UsersFields fields ) : VkCollection	Возвращает список заявок на вступление в сообщество. Страница документации ВКонтакте .
GetSettings ( ulong groupId ) : GroupsEditParams	Позволяет получать данные, необходимые для отображения страницы редактирования данных сообщества. Страница документации ВКонтакте .
GroupsCategory ( VkApi vk ) : System
Invite ( long groupId, long userId ) : bool	Позволяет приглашать друзей в группу. Страница документации ВКонтакте .
IsMember ( string groupId, long userId, IEnumerable userIds, bool extended, bool skipAuthorization = false ) : ReadOnlyCollection	Возвращает информацию о том, является ли пользователь участником сообщества. Страница документации ВКонтакте .
Join ( long groupId, bool notSure = null ) : bool	Данный метод позволяет вступить в группу, публичную страницу, а также подтвердить участие во встрече. Страница документации ВКонтакте .
Leave ( long groupId ) : bool	Позволяет покинуть сообщество. Страница документации ВКонтакте .
RemoveUser ( long groupId, long userId ) : bool	Позволяет исключить пользователя из группы или отклонить заявку на вступление. Страница документации ВКонтакте .
ReorderLink ( long groupId, long linkId, long after ) : bool	Позволяет менять местоположение ссылки в списке. Страница документации ВКонтакте .
Search ( GroupsSearchParams @params, bool skipAuthorization = false ) : VkCollection	Осуществляет поиск сообществ по заданной подстроке. Страница документации ВКонтакте .
UnbanUser ( long groupId, long userId ) : bool	Убирает пользователя из черного списка сообщества. Страница документации ВКонтакте .

Private Methods

Méthode	Description
BanUser ( long groupId, long userId, System.DateTime endDate = null, BanReason reason = null, string comment = "", bool commentVisible = false ) : bool
EditManager ( long groupId, long userId, AdminLevel role ) : bool
EditManager ( long groupId, long userId, AdminLevel role, bool isContact = null, string contactPosition = null, string contactPhone = null, string contactEmail = null ) : bool
Get ( long uid, bool extended = false, GroupsFilters filters = null, GroupsFields fields = null, uint offset, uint count = 1000 ) : ReadOnlyCollection
GetById ( long gid, GroupsFields fields = null ) : Model.Group
GetById ( string gid, GroupsFields fields = null ) : Model.Group
GetById ( IEnumerable gids, GroupsFields fields = null ) : ReadOnlyCollection
GetById ( IEnumerable gids, GroupsFields fields = null ) : ReadOnlyCollection
GetInvitedUsers ( long groupId, int &userCount, long offset = null, long count = null, UsersFields fields = null, NameCase nameCase = null ) : ReadOnlyCollection
GetMembers ( int &totalCount, GroupsGetMembersParams @params ) : ReadOnlyCollection
GetMembers ( long gid, int &totalCount, uint count = null, uint offset = null, GroupsSort sort = null, UsersFields fields = null, GroupsFilters filters = null ) : ReadOnlyCollection
GetMembers ( string gid, int &totalCount, uint count = null, uint offset = null, GroupsSort sort = null, UsersFields fields = null, GroupsFilters filters = null ) : ReadOnlyCollection
IsMember ( long gid, IEnumerable uids ) : ReadOnlyCollection
IsMember ( string gid, IEnumerable uids ) : ReadOnlyCollection
IsMember ( long gid, long uid ) : bool
IsMember ( string gid, long uid ) : bool
Search ( [ query, int &totalCount, uint offset = null, uint count = null, GroupSort sort = GroupSort.Normal, GroupType type = null, uint countryId = null, uint cityId = null, bool future = false ) : ReadOnlyCollection
Search ( int &totalCount, GroupsSearchParams @params ) : ReadOnlyCollection

Method Details

AddLink() public méthode

Позволяет добавлять ссылки в сообщество.

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

public AddLink ( long groupId, Uri link, string text ) : Link
groupId	long	Идентификатор сообщества, в которое добавляется ссылка положительное число, обязательный параметр (Положительное число, обязательный параметр).
link	System.Uri	Адрес ссылки строка, обязательный параметр (Строка, обязательный параметр).
text	string	Текст ссылки строка (Строка).
Résultat	VkNet.Model.Attachments.Link

ApproveRequest() public méthode

Позволяет одобрить заявку в группу от пользователя.

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

public ApproveRequest ( long groupId, long userId ) : bool
groupId	long	Идентификатор группы, заявку в которую необходимо одобрить.
userId	long	Идентификатор пользователя, заявку которого необходимо одобрить.
Résultat	bool

BanUser() public méthode

Добавляет пользователя в черный список сообщества.

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

public BanUser ( GroupsBanUserParams @params ) : bool
@params	GroupsBanUserParams
Résultat	bool

Create() public méthode

Создает новое сообщество.

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

public Create ( string title, string description, GroupType type, GroupSubType subtype ) : Model.Group
title	string	Название сообщества. строка, обязательный параметр (Строка, обязательный параметр).
description	string	Описание сообщества, (не учитывается при type=public). строка (Строка).
type	GroupType	Тип создаваемого сообщества: /// /// group — группа; /// event — мероприятие; /// public — публичная страница. /// строка, по умолчанию group (Строка, по умолчанию group).
subtype	GroupSubType	Вид публичной страницы (только при type=public): /// /// 1 — место или небольшая компания; /// 2 — компания, организация или веб-сайт; /// 3 — известная личность или коллектив; /// 4 — произведение или продукция. /// положительное число (Положительное число).
Résultat	Model.Group

DeleteLink() public méthode

Позволяет удалить ссылки из сообщества.

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

public DeleteLink ( long groupId, ulong linkId ) : bool
groupId	long	Идентификатор сообщества, ссылки которого нужно удалить положительное число, обязательный параметр (Положительное число, обязательный параметр).
linkId	ulong	Идентификатор ссылки, которую необходимо удалить положительное число, обязательный параметр (Положительное число, обязательный параметр).
Résultat	bool

Edit() public méthode

Редактирует сообщество.

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

public Edit ( GroupsEditParams @params ) : bool
@params	GroupsEditParams
Résultat	bool

EditLink() public méthode

Позволяет редактировать ссылки в сообществе.

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

public EditLink ( long groupId, ulong linkId, string text ) : bool
groupId	long	Идентификатор сообщества, в которое добавляется ссылка положительное число, обязательный параметр (Положительное число, обязательный параметр).
linkId	ulong	Идентификатор редактируемой ссылки положительное число, обязательный параметр (Положительное число, обязательный параметр).
text	string	Новое описание ссылки строка (Строка).
Résultat	bool

EditManager() public méthode

Позволяет назначить/разжаловать руководителя в сообществе или изменить уровень его полномочий.

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

public EditManager ( GroupsEditManagerParams @params ) : bool
@params	GroupsEditManagerParams
Résultat	bool

EditPlace() public méthode

Позволяет редактировать информацию о месте группы. Для удаления информации о местоположении нужно передать только group_id. Для обновления данных о местоположении необходимо указать как минимум id страны, широту и долготу.

Для того, чтобы воспользоваться этим методом Вы должны быть администратором группы. Страница документации ВКонтакте .

public EditPlace ( long groupId, Model.Place place = null ) : bool
groupId	long	Идентификатор группы, информацию о месте которой нужно отредактировать.
place	Model.Place	Местоположение.
Résultat	bool

Get() public méthode

Возвращает список сообществ указанного пользователя.

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

public Get ( GroupsGetParams @params, bool skipAuthorization = false ) : VkCollection
@params	GroupsGetParams
skipAuthorization	bool	Если true, то пропустить авторизацию
Résultat	VkCollection

GetBanned() public méthode

Возвращает список забаненных пользователей в сообществе.

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

public GetBanned ( long groupId, long offset = null, long count = null, GroupsFields fields = null, long userId = null ) : VkCollection
groupId	long	Идентификатор сообщества. положительное число, обязательный параметр (Положительное число, обязательный параметр).
offset	long	Смещение, необходимое для выборки определенного подмножества черного списка. положительное число (Положительное число).
count	long	Количество пользователей, которое необходимо вернуть. положительное число, по умолчанию 20, максимальное значение 200 (Положительное число, по умолчанию 20, максимальное значение 200).
fields	GroupsFields	Список дополнительных полей, которые необходимо вернуть. /// Доступные значения: sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters список строк, разделенных через запятую (Список строк, разделенных через запятую).
userId	long	Идентификатор пользователя, который можно передать для получения статуса бана отдельного пользователя. положительное число (Положительное число).
Résultat	VkCollection

GetById() public méthode

Возвращает информацию о заданном сообществе или о нескольких сообществах.

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

public GetById ( IEnumerable groupIds, string groupId, GroupsFields fields, bool skipAuthorization = false ) : ReadOnlyCollection
groupIds	IEnumerable	Идентификаторы или короткие имена сообществ. Максимальное число идентификаторов — 500. список строк, разделенных через запятую (Список строк, разделенных через запятую).
groupId	string	Идентификатор или короткое имя сообщества. строка (Строка).
fields	GroupsFields	Список дополнительных полей, которые необходимо вернуть. Возможные значения: city, country, place, description, wiki_page, members_count, counters, start_date, finish_date, can_post, can_see_all_posts, activity, status, contacts, links, fixed_post, verified, site,ban_info. /// Обратите внимание, для получения некоторых полей требуется право доступа groups. Подробнее см. описание полей объекта group список строк, разделенных через запятую (Список строк, разделенных через запятую).
skipAuthorization	bool	Если true, то пропустить авторизацию
Résultat	ReadOnlyCollection

GetCatalog() public méthode

Возвращает список сообществ выбранной категории каталога.

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

public GetCatalog ( ulong categoryId = null, ulong subcategoryId = null ) : VkCollection
categoryId	ulong	Идентификатор категории, полученный в методе groups.getCatalogInfo. положительное число (Положительное число).
subcategoryId	ulong	Идентификатор подкатегории, полученный в методе groups.getCatalogInfo. положительное число, максимальное значение 99 (Положительное число, максимальное значение 99).
Résultat	VkCollection

GetCatalogInfo() public méthode

Возвращает список категорий для каталога сообществ.

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

public GetCatalogInfo ( bool extended = null, bool subcategories = null ) : GroupsCatalogInfo
extended	bool	1 — вернуть информацию о количестве сообществ в категории и три сообщества для предпросмотра. /// По умолчанию 0. флаг, может принимать значения 1 или 0, по умолчанию 0, доступен начиная с версии 5.37 (Флаг, может принимать значения 1 или 0, по умолчанию 0, доступен начиная с версии 5.37).
subcategories	bool	1 — вернуть информацию об подкатегориях. /// По умолчанию 0. флаг, может принимать значения 1 или 0, по умолчанию 0, доступен начиная с версии 5.37 (Флаг, может принимать значения 1 или 0, по умолчанию 0, доступен начиная с версии 5.37).
Résultat	GroupsCatalogInfo

GetInvitedUsers() public méthode

Возвращает список пользователей, которые были приглашены в группу.

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

public GetInvitedUsers ( long groupId, long offset = null, long count = null, UsersFields fields = null, NameCase nameCase = null ) : VkCollection
groupId	long	Идентификатор группы, список приглашенных в которую пользователей нужно вернуть. положительное число, обязательный параметр (Положительное число, обязательный параметр).
offset	long	Смещение, необходимое для выборки определённого подмножества пользователей. положительное число (Положительное число).
count	long	Количество пользователей, информацию о которых нужно вернуть. положительное число, по умолчанию 20 (Положительное число, по умолчанию 20).
fields	UsersFields	Список дополнительных полей, которые необходимо вернуть. /// Доступные значения: 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 список строк, разделенных через запятую (Список строк, разделенных через запятую).
nameCase	NameCase	Падеж для склонения имени и фамилии пользователя. Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom. строка (Строка).
Résultat	VkCollection

GetInvites() public méthode

Данный метод возвращает список приглашений в сообщества и встречи текущего пользователя.

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

public GetInvites ( long count, long offset, bool extended = null ) : VkCollection
count	long	Количество приглашений, которое необходимо вернуть. положительное число, по умолчанию 20 (Положительное число, по умолчанию 20).
offset	long	Смещение, необходимое для выборки определённого подмножества приглашений. положительное число (Положительное число).
extended	bool	1 — вернуть дополнительную информацию о пользователях, отправлявших приглашения. По умолчанию — 0. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
Résultat	VkCollection

GetMembers() public méthode

Возвращает список участников сообщества.

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

public GetMembers ( GroupsGetMembersParams @params, bool skipAuthorization = false ) : VkCollection
@params	GroupsGetMembersParams
skipAuthorization	bool	Если true, то пропустить авторизацию
Résultat	VkCollection

GetRequests() public méthode

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

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

public GetRequests ( long groupId, long offset, long count, UsersFields fields ) : VkCollection
groupId	long	Идентификатор сообщества (указывается без знака «минус»). положительное число, обязательный параметр (Положительное число, обязательный параметр).
offset	long	Смещение, необходимое для выборки определенного подмножества результатов. По умолчанию — 0. положительное число (Положительное число).
count	long	Число результатов, которые необходимо вернуть. положительное число, по умолчанию 20, максимальное значение 200 (Положительное число, по умолчанию 20, максимальное значение 200).
fields	UsersFields	Список дополнительных полей профилей, которые необходимо вернуть. См. подробное описание. /// Доступные значения: sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters, screen_name, maiden_name, timezone, occupation,activities, interests, music, movies, tv, books, games, about, quotes список строк, разделенных через запятую (Список строк, разделенных через запятую).
Résultat	VkCollection

GetSettings() public méthode

Позволяет получать данные, необходимые для отображения страницы редактирования данных сообщества.

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

public GetSettings ( ulong groupId ) : GroupsEditParams
groupId	ulong	Идентификатор сообщества, данные которого необходимо получить. положительное число, обязательный параметр (Положительное число, обязательный параметр).
Résultat	GroupsEditParams

GroupsCategory() public méthode

public GroupsCategory ( VkApi vk ) : System
vk	VkApi
Résultat	System

Invite() public méthode

Позволяет приглашать друзей в группу.

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

public Invite ( long groupId, long userId ) : bool
groupId	long	Идентификатор группы, в которую необходимо выслать приглашение положительное число, обязательный параметр (Положительное число, обязательный параметр).
userId	long	Идентификатор пользователя, которому необходимо выслать приглашение положительное число, обязательный параметр (Положительное число, обязательный параметр).
Résultat	bool

IsMember() public méthode

Возвращает информацию о том, является ли пользователь участником сообщества.

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

public IsMember ( string groupId, long userId, IEnumerable userIds, bool extended, bool skipAuthorization = false ) : ReadOnlyCollection
groupId	string	Идентификатор или короткое имя сообщества. строка, обязательный параметр (Строка, обязательный параметр).
userId	long	Идентификатор пользователя. положительное число (Положительное число).
userIds	IEnumerable	Идентификаторы пользователей, не более 500. список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
extended	bool	1 — вернуть ответ в расширенной форме. По умолчанию — 0. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
skipAuthorization	bool	Если true, то пропустить авторизацию
Résultat	ReadOnlyCollection

Join() public méthode

Данный метод позволяет вступить в группу, публичную страницу, а также подтвердить участие во встрече.

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

public Join ( long groupId, bool notSure = null ) : bool
groupId	long	Идентификатор сообщества. положительное число (Положительное число).
notSure	bool	Опциональный параметр, учитываемый, если group_id принадлежит встрече. 1 — Возможно пойду. 0 — Точно пойду. По умолчанию 0. строка (Строка).
Résultat	bool

Leave() public méthode

Позволяет покинуть сообщество.

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

public Leave ( long groupId ) : bool
groupId	long	Идентификатор сообщества. положительное число, обязательный параметр (Положительное число, обязательный параметр).
Résultat	bool

RemoveUser() public méthode

Позволяет исключить пользователя из группы или отклонить заявку на вступление.

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

public RemoveUser ( long groupId, long userId ) : bool
groupId	long	Идентификатор группы, из которой необходимо исключить пользователя.
userId	long	Идентификатор пользователя, которого нужно исключить.
Résultat	bool

ReorderLink() public méthode

Позволяет менять местоположение ссылки в списке.

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

public ReorderLink ( long groupId, long linkId, long after ) : bool
groupId	long	Идентификатор группы, внутри которой перемещается ссылка положительное число, обязательный параметр (Положительное число, обязательный параметр).
linkId	long	Идентификатор ссылки, которую необходимо переместить положительное число, обязательный параметр (Положительное число, обязательный параметр).
after	long	Идентификатор ссылки после которой необходимо разместить перемещаемую ссылку. 0 – если ссылку нужно разместить в начале списка. положительное число (Положительное число).
Résultat	bool

Search() public méthode

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

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

public Search ( GroupsSearchParams @params, bool skipAuthorization = false ) : VkCollection
@params	GroupsSearchParams
skipAuthorization	bool	Если true, то пропустить авторизацию
Résultat	VkCollection

UnbanUser() public méthode

Убирает пользователя из черного списка сообщества.

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

public UnbanUser ( long groupId, long userId ) : bool
groupId	long	Идентификатор сообщества
userId	long	Идентификатор пользователя, которого нужно убрать из черного списка
Résultat	bool