C# Класс VkNet.VkApi

API для работы с ВКонтакте. Выступает в качестве фабрики для различных категорий API (например, для работы с пользователями, группами и т.п.).
Показать файл Открыть проект Примеры использования класса

Private Properties

Свойство Тип Описание
AlertExpires void
Authorize void
Authorize void
AuthorizeWithAntiCaptcha void
Call VkResponse
Invoke string
InvokeAsync Task
SetTimer void
StopTimer void

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

Метод Описание
Authorize ( VkNet.ApiAuthParams @params ) : void

Авторизация и получение токена
Authorize ( string accessToken, long userId = null, int expireTime ) : void

Выполняет авторизацию с помощью маркера доступа (access token), полученного извне.
AuthorizeAsync ( VkNet.ApiAuthParams @params ) : Task

Авторизация и получение токена в асинхронном режиме
Dispose ( ) : void
GetApiUrl ( string methodName, string>.IDictionary parameters, bool skipAuthorization = false ) : string

Получить URL для API.
RefreshToken ( Func code = null ) : void

Получает новый AccessToken используя логин, пароль, приложение и настройки указанные при последней авторизации.
RefreshTokenAsync ( Func code = null ) : Task

Получает новый AccessToken использую логин, пароль, приложение и настройки указанные при последней авторизации.
VkApi ( ICaptchaSolver captchaSolver = null ) : System

Инициализирует новый экземпляр класса VkApi.

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

Метод Описание
AlertExpires ( object state ) : void

Создает событие оповещения об окончании времени токена
Authorize ( int appId, string emailOrPhone, string password, Utils.Settings, settings, Func code = null, long captchaSid = null, string captchaKey = null ) : void
Authorize ( ulong appId, string emailOrPhone, string password, Utils.Settings, settings, Func code, long captchaSid = null, string captchaKey = null, string host = null, int port = null, string proxyLogin = null, string proxyPassword = null ) : void

Авторизация и получение токена
AuthorizeWithAntiCaptcha ( ulong appId, string emailOrPhone, string password, Utils.Settings, settings, Func code, long captchaSid = null, string captchaKey = null, string host = null, int port = null, string proxyLogin = null, string proxyPassword = null ) : void

Авторизация и получение токена
Call ( string methodName, VkParameters parameters, bool skipAuthorization = false ) : VkResponse
Invoke ( string methodName, string>.IDictionary parameters, bool skipAuthorization = false ) : string
InvokeAsync ( string methodName, string>.IDictionary parameters, bool skipAuthorization = false ) : Task
SetTimer ( int expireTime ) : void

Установить значение таймера
StopTimer ( ) : void

Прекращает работу таймера оповещения

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

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

Авторизация и получение токена
public Authorize ( VkNet.ApiAuthParams @params ) : void
@params VkNet.ApiAuthParams
Результат void

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

Выполняет авторизацию с помощью маркера доступа (access token), полученного извне.
public Authorize ( string accessToken, long userId = null, int expireTime ) : void
accessToken string Маркер доступа, полученный извне.
userId long Идентификатор пользователя, установившего приложение (необязательный параметр).
expireTime int Время, в течении которого действует токен доступа (0 - бесконечно).
Результат void

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

Авторизация и получение токена в асинхронном режиме
public AuthorizeAsync ( VkNet.ApiAuthParams @params ) : Task
@params VkNet.ApiAuthParams
Результат Task

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

public Dispose ( ) : void
Результат void

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

Получить URL для API.
public GetApiUrl ( string methodName, string>.IDictionary parameters, bool skipAuthorization = false ) : string
methodName string Название метода.
parameters string>.IDictionary Параметры.
skipAuthorization bool Пропускать ли авторизацию
Результат string

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

Получает новый AccessToken используя логин, пароль, приложение и настройки указанные при последней авторизации.
/// Невозможно обновить токен доступа т.к. последняя авторизация происходила не при помощи логина и пароля ///
public RefreshToken ( Func code = null ) : void
code Func Делегат двух факторной авторизации. Если не указан - будет взят из параметров (если есть)
Результат void

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

Получает новый AccessToken использую логин, пароль, приложение и настройки указанные при последней авторизации.
public RefreshTokenAsync ( Func code = null ) : Task
code Func Делегат двух факторной авторизации. Если не указан - будет взят из параметров (если есть)
Результат Task

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

Инициализирует новый экземпляр класса VkApi.
public VkApi ( ICaptchaSolver captchaSolver = null ) : System
captchaSolver ICaptchaSolver
Результат System