C# Класс kasthack.vksharp.Api.MethodGroup_Account

Показать файл Открыть проект

Открытые методы

Метод Описание
BanUser ( int userId ) : System.Threading.Tasks.Task

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

Добавляет пользователя в черный список.Если указанный пользователь является другом текущего пользователя или имеет от него входящую или исходящую заявку в друзья, то для добавления пользователя в черный список Ваше приложение должно иметь права: friends.
ChangePassword ( string restoreSid, string changePasswordHash, string oldPassword, string newPassword ) : Task

Позволяет сменить пароль пользователя после успешного восстановления доступа к аккаунту через СМС, используя метод auth.restore
ChangePasswordSync ( string restoreSid, string changePasswordHash, string oldPassword, string newPassword ) : ChangePassword

Позволяет сменить пароль пользователя после успешного восстановления доступа к аккаунту через СМС, используя метод auth.restore
GetActiveOffers ( int offset = null, int count = 100 ) : Task>

Возвращает список активных рекламных предложений (офферов), выполнив которые пользователь сможет получить соответствующее количество голосов на свой счёт внутри приложения
GetActiveOffersSync ( int offset = null, int count = 100 ) : EntityList

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

Получает настройки текущего пользователя в данном приложении
GetAppPermissionsSync ( int userId = null ) : Permission

Получает настройки текущего пользователя в данном приложении
GetBanned ( int offset = null, int count = 20 ) : Task

Возвращает список пользователей, находящихся в черном списке
GetBannedSync ( int offset = null, int count = 20 ) : User[]

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

Возвращает информацию о текущем аккаунте
GetInfoSync ( ) : AccountInfo

Возвращает информацию о текущем аккаунте
GetProfileInfo ( ) : Task

Возвращает информацию о текущем профиле
GetProfileInfoSync ( ) : User

Возвращает информацию о текущем профиле
RegisterDevice ( string token, string deviceId, string settings, int deviceYear = null, string deviceModel = "", string systemVersion = "", bool sandbox = null ) : System.Threading.Tasks.Task

Подписывает устройство на базе iOS, Android или Windows Phone на получение Push-уведомлений
RegisterDeviceSync ( string token, string deviceId, string settings, int deviceYear = null, string deviceModel = "", string systemVersion = "", bool sandbox = null ) : void

Подписывает устройство на базе 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

Редактирует информацию текущего профиля
SaveProfileInfoSync ( int cancelRequestId ) : SaveProfileInfo

Отменяет редактирование профиля
SaveProfileInfoSync ( 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 = "" ) : SaveProfileInfo

Редактирует информацию текущего профиля
SetInfo ( int intro = null, bool ownPostsDefault = null, bool noWallReplies = null ) : System.Threading.Tasks.Task

Позволяет редактировать информацию о текущем аккаунте.
SetInfoSync ( int intro = null, bool ownPostsDefault = null, bool noWallReplies = null ) : void

Позволяет редактировать информацию о текущем аккаунте.
SetNameInMenu ( string name, string userId ) : System.Threading.Tasks.Task

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

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

Помечает текущего пользователя как offline
SetOfflineSync ( ) : void

Помечает текущего пользователя как offline
SetOnline ( bool voip = true ) : System.Threading.Tasks.Task

Помечает текущего пользователя как online на 15 минут
SetOnlineSync ( bool voip = true ) : void

Помечает текущего пользователя как online на 15 минут
SetSilenceMode ( string deviceId, int time, int chatId = null, int userId = null, int sound ) : System.Threading.Tasks.Task

Отключает push-уведомления на заданный промежуток времени
SetSilenceModeSync ( string deviceId, int time, int chatId = null, int userId = null, int sound ) : void

Отключает push-уведомления на заданный промежуток времени
UnbanUser ( int userId ) : System.Threading.Tasks.Task

Убирает пользователя из черного списка
UnbanUserSync ( int userId ) : void

Убирает пользователя из черного списка
UnregisterDevice ( string deviceId, bool sandbox = null ) : System.Threading.Tasks.Task

Отписывает устройство от Push уведомлений
UnregisterDeviceSync ( string deviceId, bool sandbox = null ) : void

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

Приватные методы

Метод Описание
MethodGroup_Account ( Api parent ) : System

Описание методов

BanUser() публичный Метод

Добавляет пользователя в черный список.Если указанный пользователь является другом текущего пользователя или имеет от него входящую или исходящую заявку в друзья, то для добавления пользователя в черный список Ваше приложение должно иметь права: friends.
public BanUser ( int userId ) : System.Threading.Tasks.Task
userId int Идентификатор пользователя, которого нужно добавить в черный список
Результат System.Threading.Tasks.Task

BanUserSync() публичный Метод

Добавляет пользователя в черный список.Если указанный пользователь является другом текущего пользователя или имеет от него входящую или исходящую заявку в друзья, то для добавления пользователя в черный список Ваше приложение должно иметь права: friends.
public BanUserSync ( int userId ) : void
userId int Идентификатор пользователя, которого нужно добавить в черный список
Результат void

ChangePassword() публичный Метод

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

ChangePasswordSync() публичный Метод

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

GetActiveOffers() публичный Метод

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

GetActiveOffersSync() публичный Метод

Возвращает список активных рекламных предложений (офферов), выполнив которые пользователь сможет получить соответствующее количество голосов на свой счёт внутри приложения
public GetActiveOffersSync ( int offset = null, int count = 100 ) : EntityList
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
Результат EntityList

GetAppPermissions() публичный Метод

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

GetAppPermissionsSync() публичный Метод

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

GetBanned() публичный Метод

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

GetBannedSync() публичный Метод

Возвращает список пользователей, находящихся в черном списке
public GetBannedSync ( int offset = null, int count = 20 ) : User[]
offset int Оффсет для возврата результатов
count int Количество записей, которые необходимо вернуть
Результат User[]

GetInfo() публичный Метод

Возвращает информацию о текущем аккаунте
public GetInfo ( ) : Task
Результат Task

GetInfoSync() публичный Метод

Возвращает информацию о текущем аккаунте
public GetInfoSync ( ) : AccountInfo
Результат kasthack.vksharp.DataTypes.ResponseEntities.AccountInfo

GetProfileInfo() публичный Метод

Возвращает информацию о текущем профиле
public GetProfileInfo ( ) : Task
Результат Task

GetProfileInfoSync() публичный Метод

Возвращает информацию о текущем профиле
public GetProfileInfoSync ( ) : User
Результат User

RegisterDevice() публичный Метод

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

RegisterDeviceSync() публичный Метод

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

SaveProfileInfo() публичный Метод

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

SaveProfileInfo() публичный Метод

Редактирует информацию текущего профиля
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
Результат Task

SaveProfileInfoSync() публичный Метод

Отменяет редактирование профиля
public SaveProfileInfoSync ( int cancelRequestId ) : SaveProfileInfo
cancelRequestId int идентификатор заявки на смену имени, которую необходимо отменить
Результат kasthack.vksharp.DataTypes.ResponseEntities.SaveProfileInfo

SaveProfileInfoSync() публичный Метод

Редактирует информацию текущего профиля
public SaveProfileInfoSync ( 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 = "" ) : SaveProfileInfo
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
Результат kasthack.vksharp.DataTypes.ResponseEntities.SaveProfileInfo

SetInfo() публичный Метод

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

SetInfoSync() публичный Метод

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

SetNameInMenu() публичный Метод

Устанавливает короткое название приложения (до 17 символов), которое выводится пользователю в левом меню
public SetNameInMenu ( string name, string userId ) : System.Threading.Tasks.Task
name string короткое название приложения
userId string идентификатор пользователя
Результат System.Threading.Tasks.Task

SetNameInMenuSync() публичный Метод

Устанавливает короткое название приложения (до 17 символов), которое выводится пользователю в левом меню
public SetNameInMenuSync ( string name, string userId ) : void
name string короткое название приложения
userId string идентификатор пользователя
Результат void

SetOffline() публичный Метод

Помечает текущего пользователя как offline
public SetOffline ( ) : System.Threading.Tasks.Task
Результат System.Threading.Tasks.Task

SetOfflineSync() публичный Метод

Помечает текущего пользователя как offline
public SetOfflineSync ( ) : void
Результат void

SetOnline() публичный Метод

Помечает текущего пользователя как online на 15 минут
public SetOnline ( bool voip = true ) : System.Threading.Tasks.Task
voip bool возможны ли видеозвонки для данного устройства
Результат System.Threading.Tasks.Task

SetOnlineSync() публичный Метод

Помечает текущего пользователя как online на 15 минут
public SetOnlineSync ( bool voip = true ) : void
voip bool возможны ли видеозвонки для данного устройства
Результат void

SetSilenceMode() публичный Метод

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

SetSilenceModeSync() публичный Метод

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

UnbanUser() публичный Метод

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

UnbanUserSync() публичный Метод

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

UnregisterDevice() публичный Метод

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

UnregisterDeviceSync() публичный Метод

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