KRGoogleAuth.pas

Типы данных

TKRGoogleAuthScopes – список возможных запрашиваемых разрешений
- gscEMail – получить адрес электронной почты
- gscContactsRead – доступ на чтение контактов
- gscContacts – доступ на чтение/запись контактов
- gscCalendarRead – доступ на чтение календарей
- gscCalendar – доступ на чтение/запись календарей
- gscSheets – доступ на чтение/запись таблиц
- gscSheetsRead – доступ на чтение таблиц
- gscWebmaster – доступ на чтение/запись данных консоли поиска
- gscWebmasterRead – доступ на чтение данных консоли поиска
TKRGoogleAuthScope – набор запрашиваемых разрешений TKRGoogleAuthScopes

Классы

Класс TKRGoogleAuth

Родительский класс TComponent

TKRGoogleAuth – производит сетевую авторизацию по протоколу OAuth 2.0 с аккаунтом Google. При авторизации получает token доступа, краткую информацию о пользователе и его фото. Если получен Refresh Token, то производится автоматическое обновление токена доступа за 5 минут до истечении времени из свойства ExpiresIn. Для работы нужно создать приложение в консоли Google и в "Разрешенные URI перенаправления" указать http://127.0.0.1:xxxx , где xxxx это порт указанный в свойстве Port

Свойства класса TKRGoogleAuth

property Token: string;

Token – токен доступа текущей авторизации. Если значение не пустое, авторизация прошла успешно. Только чтение

property UserID: string;

UserID – идентификатор авторизованного пользователя. Только чтение

property UserName: String;

UserName – полное имя авторизованного пользователя. Только чтение

property UserGivenName: String;

UserGivenName – имя авторизованного пользователя. Только чтение

property UserFamilyName: String;

UserFamilyName – фамилия авторизованного пользователя. Только чтение

property UserEmail: String;

UserEmail – адрес электронной почты авторизованного пользователя. Будет получено если установлено разрешение gscEMail. Только чтение

property UserIcon: TBitmap;

UserIcon – фото авторизованного пользователя. Только чтение

property ExpiresIn: TDateTime;

ExpiresIn – время жизни токена доступа. Только чтение

property LoginTimeout: Cardinal;

LoginTimeout – таймаут авторизации в миллисекундах. Если в течении этого времени не удается авторизоваться, то процесс останавливается и вызывается событие OnError

property AppID: String;

AppID – идентификатор приложения

property SecretKey: String;

SecretKey – секретный ключ приложения

property Scope: TKRGoogleAuthScope;

Scope – набор запрашиваемых разрешений

property Port: word;

Port – порт локального сервера для переадресации. В момент авторизации, для перехвата переадресации создается TCP сервер, который слушает данный порт

property DataFolder: String;

DataFolder – папка для хранения данных пользователей и настроек авторизации. Путь можно указывать прямой или относительный(относительно расположения исполняемого файла)

События класса TKRGoogleAuth

property OnError: TNotifyEvent;

OnError – вызывается при неудачной авторизации

property OnLogin: TNotifyEvent;

OnLogin – вызывается при успешной авторизации

property OnLogout: TNotifyEvent;

OnLogout – вызывается при выходе пользователя из аккаунта

Методы класса TKRGoogleAuth

function Login: boolean;

Login – производит авторизацию пользователя. Если нет Refresh Tocken, или он не верный, то откроется окно с браузером для авторизации.

function Logout: boolean;

Logout – выход из учетной записи

function RefreshToken: boolean;

RefreshToken – возвращает True если есть Refresh Tocken

function GetRefreshToken: String;

GetRefreshToken – возвращает значение текущего Refresh Tocken

function GetUserIcon(AURL: String; AETag: String = ''; AAccessToken: boolean = false): TBitmap;

GetUserIcon – получение фото пользователя по URI
- AURL – адрес фото
- AETag – признак последнего изменения
- AAccessToken – признак добавления текущего токена доступа к адресу