C# Class VkNet.Categories.AccountCategory

Методы этого класса позволяют производить действия с аккаунтом пользователя.

Show file Open project: vknet/vk Class Usage Examples

Public Methods

Method	Description
AccountCategory ( VkApi vk ) : System.Collections.Generic	Методы для работы с аккаунтом пользователя.
BanUser ( long userId ) : bool	Добавляет пользователя в черный список. Страница документации ВКонтакте .
ChangePassword ( string oldPassword, string newPassword, string restoreSid = null, string changePasswordHash = null ) : AccountChangePasswordResult	Позволяет сменить пароль пользователя после успешного восстановления доступа к аккаунту через СМС, используя метод auth.restore. Страница документации ВКонтакте .
GetActiveOffers ( ulong offset = null, ulong count = null ) : InformationAboutOffers	Возвращает список активных рекламных предложений (офферов), выполнив которые пользователь сможет получить соответствующее количество голосов на свой счёт внутри приложения. Страница документации ВКонтакте .
GetAppPermissions ( long userId ) : long	Получает настройки текущего пользователя в данном приложении. Страница документации ВКонтакте .
GetBanned ( int offset = null, int count = null ) : VkCollection	Возвращает список пользователей, находящихся в черном списке. Страница документации ВКонтакте .
GetCounters ( CountersFilter filter ) : Counters	Возвращает ненулевые значения счетчиков пользователя. Страница документации ВКонтакте .
GetInfo ( AccountFields fields = null ) : Model.AccountInfo	Возвращает информацию о текущем аккаунте. Страница документации ВКонтакте .
GetPushSettings ( string deviceId ) : AccountPushSettings	Позволяет получать настройки Push уведомлений. Страница документации ВКонтакте .
LookupContacts ( List contacts, Services service, string mycontact = null, bool returnAll = null, UsersFields fields = null ) : LookupContactsResult	Позволяет искать пользователей ВКонтакте, используя телефонные номера, email-адреса, и идентификаторы пользователей в других сервисах. Найденные пользователи могут быть также в дальнейшем получены методом friends.getSuggestions. Страница документации ВКонтакте .
RegisterDevice ( AccountRegisterDeviceParams @params ) : bool	Подписывает устройство на базе iOS, Android или Windows Phone на получение Push-уведомлений. Страница документации ВКонтакте .
SaveProfileInfo ( ChangeNameRequest &changeNameRequest, AccountSaveProfileInfoParams @params ) : bool	Редактирует информацию текущего профиля. Страница документации ВКонтакте http://vk.com/dev/account.saveProfileInfo.
SaveProfileInfo ( int cancelRequestId ) : bool	Редактирует информацию текущего профиля. Метод вынесен как отдельный, потому что если в запросе передан параметр cancelRequestId, все остальные параметры игнорируются.Страница документации ВКонтакте http://vk.com/dev/account.saveProfileInfo.
SetInfo ( [ name, [ value ) : bool	Позволяет редактировать информацию о текущем аккаунте. Страница документации ВКонтакте .
SetNameInMenu ( [ name, long userId = null ) : bool	Устанавливает короткое название приложения (до 17 символов), которое выводится пользователю в левом меню. Страница документации ВКонтакте .
SetOffline ( ) : bool	Помечает текущего пользователя как offline. Страница документации ВКонтакте .
SetOnline ( bool voip = null ) : bool	Помечает текущего пользователя как online на 15 минут. Страница документации ВКонтакте .
SetPushSettings ( string deviceId, PushSettings settings, string key, List value ) : bool	Изменяет настройку Push-уведомлений. Страница документации ВКонтакте .
SetSilenceMode ( [ deviceId, int time = null, int peerId = null, bool sound = null ) : bool	Отключает push-уведомления на заданный промежуток времени. Страница документации ВКонтакте http://vk.com/dev/account.setSilenceMode.
UnbanUser ( long userId ) : bool	Убирает пользователя из черного списка. Страница документации ВКонтакте .
UnregisterDevice ( string deviceId, bool sandbox = null ) : bool	Отписывает устройство от Push уведомлений. Страница документации ВКонтакте .

Private Methods

Method	Description
GetBanned ( int &total, int offset = null, int count = null ) : ReadOnlyCollection
GetProfileInfo ( ) : AccountSaveProfileInfoParams
RegisterDevice ( [ token, string deviceModel, string systemVersion, bool noText = null, SubscribeFilter subscribe = null ) : bool
SaveProfileInfo ( ChangeNameRequest &changeNameRequest, string firstName = null, string lastName = null, string maidenName = null, Sex sex = null, RelationType relation = null, long relationPartnerId = null, System.DateTime birthDate = null, BirthdayVisibility birthDateVisibility = null, string homeTown = null, long countryId = null, long cityId = null ) : bool
SaveProfileInfo ( string firstName = null, string lastName = null, string maidenName = null, Sex sex = null, RelationType relation = null, long relationPartnerId = null, System.DateTime birthDate = null, BirthdayVisibility birthDateVisibility = null, string homeTown = null, long countryId = null, long cityId = null ) : bool

Method Details

AccountCategory() public method

Методы для работы с аккаунтом пользователя.

public AccountCategory ( VkApi vk ) : System.Collections.Generic
vk	VkApi	API.
return	System.Collections.Generic

BanUser() public method

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

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

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

ChangePassword() public method

Позволяет сменить пароль пользователя после успешного восстановления доступа к аккаунту через СМС, используя метод auth.restore.

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

public ChangePassword ( string oldPassword, string newPassword, string restoreSid = null, string changePasswordHash = null ) : AccountChangePasswordResult
oldPassword	string	Текущий пароль пользователя. строка (Строка).
newPassword	string	Новый пароль, который будет установлен в качестве текущего. строка, минимальная длина 6, обязательный параметр (Строка, минимальная длина 6, обязательный параметр).
restoreSid	string	Идентификатор сессии, полученный при восстановлении доступа используя метод auth.restore. (В случае если пароль меняется сразу после восстановления доступа) строка (Строка).
changePasswordHash	string	Хэш, полученный при успешной OAuth авторизации по коду полученному по СМС (В случае если пароль меняется сразу после восстановления доступа) строка (Строка).
return	AccountChangePasswordResult

GetActiveOffers() public method

Возвращает список активных рекламных предложений (офферов), выполнив которые пользователь сможет получить соответствующее количество голосов на свой счёт внутри приложения.

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

public GetActiveOffers ( ulong offset = null, ulong count = null ) : InformationAboutOffers
offset	ulong	Смещение, необходимое для выборки определенного подмножества офферов. положительное число, по умолчанию 0 (Положительное число, по умолчанию 0).
count	ulong	Количество офферов, которое необходимо получить положительное число, по умолчанию 100, максимальное значение 100 (Положительное число, по умолчанию 100, максимальное значение 100).
return	InformationAboutOffers

GetAppPermissions() public method

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

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

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

GetBanned() public method

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

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

public GetBanned ( int offset = null, int count = null ) : VkCollection
offset	int	Смещение необходимое для выборки определенного подмножества черного списка. положительное число (Положительное число).
count	int	Количество записей, которое необходимо вернуть. положительное число, по умолчанию 20, максимальное значение 200 (Положительное число, по умолчанию 20, максимальное значение 200).
return	VkCollection

GetCounters() public method

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

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

public GetCounters ( CountersFilter filter ) : Counters
filter	CountersFilter	Счетчики, информацию о которых нужно вернуть (friends, messages, photos, videos, notes, gifts, events, groups, notifications, sdk, app_requests). /// sdk - возвращает количество запросов в приложениях. /// app_requests - возвращает количество непрочитанных запросов в приложениях. список слов, разделенных через запятую (Список слов, разделенных через запятую).
return	Counters

GetInfo() public method

Возвращает информацию о текущем аккаунте.

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

public GetInfo ( AccountFields fields = null ) : Model.AccountInfo
fields	AccountFields	Список полей, которые необходимо вернуть. Возможные значения: (country, http_required, own_posts_default, no_wall_replies, intro, lang, По умолчанию будут возвращены все поля. список слов, разделенных через запятую (Список слов, разделенных через запятую).
return	Model.AccountInfo

GetPushSettings() public method

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

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

public GetPushSettings ( string deviceId ) : AccountPushSettings
deviceId	string	Уникальный идентификатор устройства. строка, доступен начиная с версии 5.31 (Строка, доступен начиная с версии 5.31).
return	AccountPushSettings

LookupContacts() public method

Позволяет искать пользователей ВКонтакте, используя телефонные номера, email-адреса, и идентификаторы пользователей в других сервисах. Найденные пользователи могут быть также в дальнейшем получены методом friends.getSuggestions.

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

public LookupContacts ( List contacts, Services service, string mycontact = null, bool returnAll = null, UsersFields fields = null ) : LookupContactsResult
contacts	List	Список контактов, разделенных через запятую. список слов, разделенных через запятую (Список слов, разделенных через запятую).
service	Services	Строковой идентификатор сервиса, по контактам которого производится поиск. Может принимать следующие значения: (email, phone, twitter, facebook, odnoklassniki, instagram, google) строка, обязательный параметр (Строка, обязательный параметр).
mycontact	string	Контакт текущего пользователя в заданном сервисе. строка (Строка).
returnAll	bool	1 – возвращать также контакты, найденные ранее с использованием этого сервиса, 0 – возвращать только контакты, найденные с использованием поля contacts. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
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 список слов, разделенных через запятую (Список слов, разделенных через запятую).
return	LookupContactsResult

RegisterDevice() public method

Подписывает устройство на базе iOS, Android или Windows Phone на получение Push-уведомлений.

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

public RegisterDevice ( AccountRegisterDeviceParams @params ) : bool
@params	AccountRegisterDeviceParams
return	bool

SaveProfileInfo() public method

Редактирует информацию текущего профиля.

Страница документации ВКонтакте http://vk.com/dev/account.saveProfileInfo.

public SaveProfileInfo ( ChangeNameRequest &changeNameRequest, AccountSaveProfileInfoParams @params ) : bool
changeNameRequest	ChangeNameRequest	Если в параметрах передавалось имя или фамилия пользователя, /// в этом параметре будет возвращен объект типа , содержащий информацию о заявке на смену имени.
@params	AccountSaveProfileInfoParams
return	bool

SaveProfileInfo() public method

Редактирует информацию текущего профиля.

Метод вынесен как отдельный, потому что если в запросе передан параметр cancelRequestId, все остальные параметры игнорируются. Страница документации ВКонтакте http://vk.com/dev/account.saveProfileInfo.

public SaveProfileInfo ( int cancelRequestId ) : bool
cancelRequestId	int	Идентификатор заявки на смену имени, которую необходимо отменить.
return	bool

SetInfo() public method

Позволяет редактировать информацию о текущем аккаунте.

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

public SetInfo ( [ name, [ value ) : bool
name	[	Имя настройки.
value	[	Значение настройки.
return	bool

SetNameInMenu() public method

Устанавливает короткое название приложения (до 17 символов), которое выводится пользователю в левом меню.

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

public SetNameInMenu ( [ name, long userId = null ) : bool
name	[	Короткое название приложения. строка (Строка).
userId	long	Идентификатор пользователя. положительное число, по умолчанию идентификатор текущего пользователя, обязательный параметр (Положительное число, по умолчанию идентификатор текущего пользователя, обязательный параметр).
return	bool

SetOffline() public method

Помечает текущего пользователя как offline.

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

public SetOffline ( ) : bool
return	bool

SetOnline() public method

Помечает текущего пользователя как online на 15 минут.

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

public SetOnline ( bool voip = null ) : bool
voip	bool	Возможны ли видеозвонки для данного устройства флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
return	bool

SetPushSettings() public method

Изменяет настройку Push-уведомлений.

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

public SetPushSettings ( string deviceId, PushSettings settings, string key, List value ) : bool
deviceId	string	Уникальный идентификатор устройства. строка, обязательный параметр (Строка, обязательный параметр).
settings	PushSettings	Сериализованный JSON-объект, описывающий настройки уведомлений в специальном формате данные в формате JSON (Данные в формате JSON).
key	string	Ключ уведомления. строка (Строка).
value	List	Новое значение уведомления в специальном формате. список слов, разделенных через запятую (Список слов, разделенных через запятую).
return	bool

SetSilenceMode() public method

Отключает push-уведомления на заданный промежуток времени.

Страница документации ВКонтакте http://vk.com/dev/account.setSilenceMode.

public SetSilenceMode ( [ deviceId, int time = null, int peerId = null, bool sound = null ) : bool
deviceId	[	Идентификатор устройства для сервиса push уведомлений.
time	int	Время в секундах на которое требуется отключить уведомления. (-1 - отключить навсегда)
peerId	int	Идентификатор чата, для которого следует отключить уведомления.
sound	bool	1 - включить звук в данном диалоге, 0 - отключить звук (параметр работает только если указан в peer_id передан идентификатор групповой беседы или пользователя)
return	bool

UnbanUser() public method

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

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

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

UnregisterDevice() public method

Отписывает устройство от Push уведомлений.

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

public UnregisterDevice ( string deviceId, bool sandbox = null ) : bool
deviceId	string	Уникальный идентификатор устройства. строка, доступен начиная с версии 5.31 (Строка, доступен начиная с версии 5.31).
sandbox	bool	Флаг предназначен для iOS устройств. 1 — отписать устройство, использующего sandbox сервер для отправки push-уведомлений, 0 — отписать устройство, не использующее sandbox сервер флаг, может принимать значения 1 или 0, по умолчанию 0 (Флаг, может принимать значения 1 или 0, по умолчанию 0).
return	bool