C# Class kasthack.vksharp.RawApi.MethodGroup_Account

Mostrar archivo Open project: kasthack/kasthack.vksharp

Public Methods

Method	Description
BanUser ( int userId ) : Task	Добавляет пользователя в черный список.Если указанный пользователь является другом текущего пользователя или имеет от него входящую или исходящую заявку в друзья, то для добавления пользователя в черный список Ваше приложение должно иметь права: friends.
ChangePassword ( string restoreSid, string changePasswordHash, string oldPassword, string newPassword ) : Task	Позволяет сменить пароль пользователя после успешного восстановления доступа к аккаунту через СМС, используя метод auth.restore
GetActiveOffers ( int offset = null, int count = 100 ) : Task	Возвращает список активных рекламных предложений (офферов), выполнив которые пользователь сможет получить соответствующее количество голосов на свой счёт внутри приложения
GetAppPermissions ( int userId = null ) : Task	Получает настройки текущего пользователя в данном приложении
GetBanned ( int offset = null, int count = 20 ) : Task	Возвращает список пользователей, находящихся в черном списке
GetInfo ( ) : Task	Возвращает информацию о текущем аккаунте
GetProfileInfo ( ) : Task	Возвращает информацию о текущем профиле
RegisterDevice ( string token, string deviceId, string settings, int deviceYear = null, string deviceModel = "", string systemVersion = "", bool sandbox = null ) : Task	Подписывает устройство на базе iOS, Android или Windows Phone на получение Push-уведомлений
SaveProfileInfo ( int cancelRequestId ) : Task	Отменяет редактирование профиля
SaveProfileInfo ( string firstName = "", string lastName = "", string maidenName = "", string screenName = "", Sex sex = null, Relation relation = null, int relationPartnerId = null, Date bdate = null, string homeTown = "", int countryId = null, int cityId = null, string status = "" ) : Task	Редактирует информацию текущего профиля
SetInfo ( int intro = null, bool ownPostsDefault = null, bool noWallReplies = null ) : Task	Позволяет редактировать информацию о текущем аккаунте.
SetNameInMenu ( string name, string userId ) : Task	Устанавливает короткое название приложения (до 17 символов), которое выводится пользователю в левом меню
SetOffline ( ) : Task	Помечает текущего пользователя как offline
SetOnline ( bool voip = true ) : Task	Помечает текущего пользователя как online на 15 минут
SetSilenceMode ( string deviceId, int time, int chatId = null, int userId = null, int sound ) : Task	Отключает push-уведомления на заданный промежуток времени
UnbanUser ( int userId ) : Task	Убирает пользователя из черного списка
UnregisterDevice ( string deviceId, bool sandbox = null ) : Task	Отписывает устройство от Push уведомлений

Private Methods

Method	Description
MethodGroup_Account ( RawApi parent ) : System

Method Details

BanUser() public method

Добавляет пользователя в черный список.Если указанный пользователь является другом текущего пользователя или имеет от него входящую или исходящую заявку в друзья, то для добавления пользователя в черный список Ваше приложение должно иметь права: friends.

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

ChangePassword() public method

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

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

GetActiveOffers() public method

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

public GetActiveOffers ( int offset = null, int count = 100 ) : Task
offset	int	Оффсет для возврата результатов
count	int	Количество записей, которые необходимо вернуть
return	Task

GetAppPermissions() public method

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

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

GetBanned() public method

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

public GetBanned ( int offset = null, int count = 20 ) : Task
offset	int	Оффсет для возврата результатов
count	int	Количество записей, которые необходимо вернуть
return	Task

GetInfo() public method

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

public GetInfo ( ) : Task
return	Task

GetProfileInfo() public method

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

public GetProfileInfo ( ) : Task
return	Task

RegisterDevice() public method

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

public RegisterDevice ( string token, string deviceId, string settings, int deviceYear = null, string deviceModel = "", string systemVersion = "", bool sandbox = null ) : Task
token	string	Идентификатор устройства, используемый для отправки уведомлений. (для mpns идентификатор должен представлять из себя URL для отправки уведомлений)
deviceId	string	уникальный идентификатор устройства
settings	string	сериализованный JSON-объект, описывающий настройки уведомлений в специальном формате
deviceYear	int	год устройства
deviceModel	string	cтроковое название модели устройства
systemVersion	string	строковая версия операционной системы устройства
sandbox	bool	(iOS) использовать sandbox сервер для отправки push-уведомлений
return	Task

SaveProfileInfo() public method

Отменяет редактирование профиля

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

SaveProfileInfo() public method

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

public SaveProfileInfo ( string firstName = "", string lastName = "", string maidenName = "", string screenName = "", Sex sex = null, Relation relation = null, int relationPartnerId = null, Date bdate = null, string homeTown = "", int countryId = null, int cityId = null, string status = "" ) : Task
firstName	string	имя пользователя
lastName	string	фамилия пользователя.
maidenName	string	девичья фамилия пользователя (только для женского пола)
screenName	string	короткое имя страницы
sex	Sex	пол пользователя
relation	Relation	семейное положение пользователя
relationPartnerId	int	идентификатор пользователя, с которым связано семейное положение
bdate	Date	дата рождения пользователя
homeTown	string	родной город пользователя
countryId	int	идентификатор страны пользователя
cityId	int	идентификатор города пользователя
status	string	статус пользователя, который также может быть изменен методом status.set
return	Task

SetInfo() public method

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

public SetInfo ( int intro = null, bool ownPostsDefault = null, bool noWallReplies = null ) : Task
intro	int	битовая маска, отвечающая за прохождение обучения в мобильных клиентах
ownPostsDefault	bool	Отображать по дефолту только записи пользователя
noWallReplies	bool	отключить комментирование записей на стене
return	Task

SetNameInMenu() public method

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

public SetNameInMenu ( string name, string userId ) : Task
name	string	короткое название приложения
userId	string	идентификатор пользователя
return	Task

SetOffline() public method

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

public SetOffline ( ) : Task
return	Task

SetOnline() public method

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

public SetOnline ( bool voip = true ) : Task
voip	bool	возможны ли видеозвонки для данного устройства
return	Task

SetSilenceMode() public method

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

public SetSilenceMode ( string deviceId, int time, int chatId = null, int userId = null, int sound ) : Task
deviceId	string	уникальный идентификатор устройства
time	int	время в секундах на которое требуется отключить уведомления, -1 отключить навсегда
chatId	int
userId	int	идентификатор пользователя
sound	int	включить/отключить звук в данном диалоге
return	Task

UnbanUser() public method

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

public UnbanUser ( int userId ) : Task
userId	int	идентификатор пользователя, которого нужно убрать из черного списка
return	Task

UnregisterDevice() public method

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

public UnregisterDevice ( string deviceId, bool sandbox = null ) : Task
deviceId	string	уникальный идентификатор устройства
sandbox	bool	отписать устройство, использующее sandbox сервер для отправки push-уведомлений
return	Task