C# Class VkNet.Categories.FriendsCategory

Методы для работы с друзьями.

显示文件 Open project: vknet/vk Class Usage Examples

Public Methods

Method	Description
Add ( long userId, string text = "", bool follow = null, long captchaSid = null, string captchaKey = null ) : AddFriendStatus	Одобряет или создает заявку на добавление в друзья. Страница документации ВКонтакте .
AddList ( string name ) : long	Создает новый список друзей у текущего пользователя. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Friends. Страница документации ВКонтакте .
AddList ( string name, IEnumerable userIds ) : long	Создает новый список друзей у текущего пользователя. Страница документации ВКонтакте .
Delete ( long userId ) : DeleteFriendStatus	Удаляет пользователя из списка друзей или отклоняет заявку в друзья. Страница документации ВКонтакте .
DeleteAllRequests ( ) : bool	Отмечает все входящие заявки на добавление в друзья как просмотренные. Страница документации ВКонтакте .
DeleteList ( long listId ) : bool	Удаляет существующий список друзей текущего пользователя. Страница документации ВКонтакте .
Edit ( long userId, IEnumerable listIds ) : bool	Редактирует списки друзей для выбранного друга. Страница документации ВКонтакте .
EditList ( long listId, string name = null, IEnumerable userIds = null, IEnumerable addUserIds = null, IEnumerable deleteUserIds = null ) : bool	Редактирует существующий список друзей текущего пользователя. Страница документации ВКонтакте .
FriendsCategory ( VkApi vk ) : System
Get ( FriendsGetParams @params, bool skipAuthorization = false ) : VkCollection	Возвращает список идентификаторов друзей пользователя или расширенную информацию о друзьях пользователя (при использовании параметра fields). Страница документации ВКонтакте .
GetAvailableForCall ( ProfileFields fields, NameCase nameCase ) : VkCollection	Позволяет получить список идентификаторов пользователей, доступных для вызова в приложении, используя метод JSAPI callUser. Подробнее о схеме вызова из приложений. Страница документации ВКонтакте .
GetByPhones ( IEnumerable phones, ProfileFields fields ) : ReadOnlyCollection	Возвращает список друзей пользователя, у которых завалидированные или указанные в профиле телефонные номера входят в заданный список. Страница документации ВКонтакте .
GetLists ( long userId = null, bool returnSystem = null ) : VkCollection	Возвращает список меток друзей текущего пользователя. Страница документации ВКонтакте .
GetMutual ( FriendsGetMutualParams @params ) : ReadOnlyCollection	Возвращает список идентификаторов общих друзей между парой пользователей. Страница документации ВКонтакте .
GetOnline ( FriendsGetOnlineParams @params ) : ReadOnlyCollection	Возвращает список идентификаторов друзей пользователя, находящихся на сайте. Страница документации ВКонтакте .
GetOnlineEx ( FriendsGetOnlineParams @params ) : FriendOnline	Возвращает список идентификаторов друзей пользователя, находящихся на сайте. Страница документации ВКонтакте .
GetRecent ( long count = null ) : ReadOnlyCollection	Возвращает список идентификаторов недавно добавленных друзей текущего пользователя. Страница документации ВКонтакте .
GetRequests ( FriendsGetRequestsParams @params ) : ReadOnlyCollection>.IDictionary	Возвращает информацию о полученных или отправленных заявках на добавление в друзья для текущего пользователя. Страница документации ВКонтакте .
GetSuggestions ( FriendsFilter filter = null, long count = null, long offset = null, UsersFields fields = null, NameCase nameCase = null ) : VkCollection	Возвращает список профилей пользователей, которые могут быть друзьями текущего пользователя. Страница документации ВКонтакте .
Search ( FriendsSearchParams @params ) : VkCollection	Позволяет искать по списку друзей пользователей. Страница документации ВКонтакте .

Private Methods

Method	Description
Add ( long userId, string text, long captchaSid = null, string captchaKey = null ) : AddFriendStatus
AreFriends ( [ userIds, bool needSign = null ) : FriendStatus>.IDictionary
Get ( long uid, ProfileFields fields = null, int count = null, int offset = null, FriendsOrder order = null, NameCase nameCase = null, int listId = null ) : ReadOnlyCollection
GetAppUsers ( ) : ReadOnlyCollection
GetMutual ( long targetUid, long sourceUid ) : ReadOnlyCollection
GetOnline ( long uid ) : ReadOnlyCollection
GetRequests ( int count = null, int offset = null, bool extended = false, bool needMutual = false, bool @out = false, bool sort = false, bool suggested = false ) : ReadOnlyCollection

Method Details

Add() public method

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

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

public Add ( long userId, string text = "", bool follow = null, long captchaSid = null, string captchaKey = null ) : AddFriendStatus
userId	long	Идентификатор пользователя, которому необходимо отправить заявку, либо заявку от которого необходимо одобрить. положительное число, обязательный параметр (Положительное число, обязательный параметр).
text	string	Текст сопроводительного сообщения для заявки на добавление в друзья. Максимальная длина сообщения — 500 символов. строка (Строка).
follow	bool	Флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
captchaSid	long	Id капчи (только если для вызова метода необходимо ввести капчу)
captchaKey	string	Текст капчи (только если для вызова метода необходимо ввести капчу)
return	AddFriendStatus

AddList() public method

Создает новый список друзей у текущего пользователя.

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

public AddList ( string name ) : long
name	string	Название создаваемого списка друзей.
return	long

AddList() public method

Создает новый список друзей у текущего пользователя.

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

public AddList ( string name, IEnumerable userIds ) : long
name	string	Название создаваемого списка друзей. строка, обязательный параметр (Строка, обязательный параметр).
userIds	IEnumerable	Идентификаторы пользователей, которых необходимо поместить в созданный список. список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
return	long

Delete() public method

Удаляет пользователя из списка друзей или отклоняет заявку в друзья.

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

public Delete ( long userId ) : DeleteFriendStatus
userId	long	Идентификатор пользователя, которого необходимо удалить из списка друзей, либо заявку от которого необходимо отклонить. положительное число, обязательный параметр (Положительное число, обязательный параметр).
return	DeleteFriendStatus

DeleteAllRequests() public method

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

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

public DeleteAllRequests ( ) : bool
return	bool

DeleteList() public method

Удаляет существующий список друзей текущего пользователя.

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

public DeleteList ( long listId ) : bool
listId	long	Идентификатор списка друзей, который необходимо удалить. положительное число, обязательный параметр (Положительное число, обязательный параметр).
return	bool

Edit() public method

Редактирует списки друзей для выбранного друга.

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

public Edit ( long userId, IEnumerable listIds ) : bool
userId	long	Идентификатор пользователя (из числа друзей), для которого необходимо отредактировать списки друзей. положительное число, обязательный параметр (Положительное число, обязательный параметр).
listIds	IEnumerable	Идентификаторы списков друзей, в которые нужно добавить пользователя. список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
return	bool

EditList() public method

Редактирует существующий список друзей текущего пользователя.

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

public EditList ( long listId, string name = null, IEnumerable userIds = null, IEnumerable addUserIds = null, IEnumerable deleteUserIds = null ) : bool
listId	long	Идентификатор списка друзей. положительное число, обязательный параметр (Положительное число, обязательный параметр).
name	string	Название списка друзей. строка (Строка).
userIds	IEnumerable	Идентификаторы пользователей, включенных в список. список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
addUserIds	IEnumerable	Идентификаторы пользователей, которых необходимо добавить в список. (в случае если не передан user_ids) список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
deleteUserIds	IEnumerable	Идентификаторы пользователей, которых необходимо изъять из списка. (в случае если не передан user_ids) список положительных чисел, разделенных запятыми (Список положительных чисел, разделенных запятыми).
return	bool

FriendsCategory() public method

public FriendsCategory ( VkApi vk ) : System
vk	VkApi
return	System

Get() public method

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

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

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

GetAvailableForCall() public method

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

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

public GetAvailableForCall ( ProfileFields fields, NameCase nameCase ) : VkCollection
fields	ProfileFields	Список дополнительных полей, которые необходимо вернуть. /// Доступные значения: 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. строка, по умолчанию Nom (Строка, по умолчанию Nom).
return	VkCollection

GetByPhones() public method

Возвращает список друзей пользователя, у которых завалидированные или указанные в профиле телефонные номера входят в заданный список.

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

public GetByPhones ( IEnumerable phones, ProfileFields fields ) : ReadOnlyCollection
phones	IEnumerable	Список телефонных номеров в формате MSISDN, разделеннных запятыми. Например /// +79219876543,+79111234567 /// Максимальное количество номеров в списке — 1000. список строк, разделенных через запятую (Список строк, разделенных через запятую).
fields	ProfileFields	Список дополнительных полей, которые необходимо вернуть. /// Доступные значения: nickname, screen_name, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, counters, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities список строк, разделенных через запятую (Список строк, разделенных через запятую).
return	ReadOnlyCollection

GetLists() public method

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

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

public GetLists ( long userId = null, bool returnSystem = null ) : VkCollection
userId	long	Идентификатор пользователя. положительное число, по умолчанию идентификатор текущего пользователя (Положительное число, по умолчанию идентификатор текущего пользователя).
returnSystem	bool	Возвращать ли системный список публичных меток друзей пользователя. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
return	VkCollection

GetMutual() public method

Возвращает список идентификаторов общих друзей между парой пользователей.

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

public GetMutual ( FriendsGetMutualParams @params ) : ReadOnlyCollection
@params	FriendsGetMutualParams
return	ReadOnlyCollection

GetOnline() public method

Возвращает список идентификаторов друзей пользователя, находящихся на сайте.

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

public GetOnline ( FriendsGetOnlineParams @params ) : ReadOnlyCollection
@params	FriendsGetOnlineParams
return	ReadOnlyCollection

GetOnlineEx() public method

Возвращает список идентификаторов друзей пользователя, находящихся на сайте.

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

public GetOnlineEx ( FriendsGetOnlineParams @params ) : FriendOnline
@params	FriendsGetOnlineParams
return	FriendOnline

GetRecent() public method

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

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

public GetRecent ( long count = null ) : ReadOnlyCollection
count	long	Максимальное количество недавно добавленных друзей, которое необходимо получить. положительное число, по умолчанию 100, максимальное значение 1000 (Положительное число, по умолчанию 100, максимальное значение 1000).
return	ReadOnlyCollection

GetRequests() public method

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

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

public GetRequests ( FriendsGetRequestsParams @params ) : ReadOnlyCollection>.IDictionary
@params	FriendsGetRequestsParams
return	ReadOnlyCollection>.IDictionary

GetSuggestions() public method

Возвращает список профилей пользователей, которые могут быть друзьями текущего пользователя.

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

public GetSuggestions ( FriendsFilter filter = null, long count = null, long offset = null, UsersFields fields = null, NameCase nameCase = null ) : VkCollection
filter	FriendsFilter	Типы предлагаемых друзей, которые нужно вернуть, перечисленные через запятую.
count	long	Количество рекомендаций, которое необходимо вернуть. положительное число, максимальное значение 500, по умолчанию 500 (положительное число, максимальное значение 500, по умолчанию 500).
offset	long	Смещение, необходимое для выбора определённого подмножества списка. положительное число (положительное число).
fields	UsersFields	Список дополнительных полей, которые необходимо вернуть. Доступные значения: nickname, screen_name, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, counters, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities список строк, разделенных через запятую(список строк, разделенных через запятую).
nameCase	NameCase	Падеж для склонения имени и фамилии пользователя. Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom. строка (строка).
return	VkCollection

Search() public method

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

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

public Search ( FriendsSearchParams @params ) : VkCollection
@params	FriendsSearchParams
return	VkCollection