TGPassportKit

KO | EN

gitlite — search

#javascript #hacktoberfest #react #machine-learning #rust #deep-learning #macos #java #cli #kubernetes #vue #pytorch #security #open-source

(★ 53)

TGPassportKit helps you easily integrate Telegram Passport requests into your iOS & macOS apps.

TGPassportKit 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TGPassportKit — Telegram Passport SDK for iOS & macOS

TGPassportKit helps you easily integrate Telegram Passport requests into your iOS & macOS apps.

### Installation

#### Installing using Cocoapods
To install TGPassportKit via Cocoapods add the following to your Podfile:
```ruby
target 'MyApp' do
pod 'TGPassportKit' 
end
```
then run `pod install` in your project root directory.

#### Installing using Carthage
Add the following line to your Cartfile:
```ruby
github "telegrammessenger/TGPassportKit"
```
then run `carthage update`, and you will get the latest version of TGPassportKit in your Carthage folder.

### Project Setup
#### Configure Your Info.plist
Configure your Info.plist by right-clicking it in Project Navigator, choosing **Open As > Source Code** and adding this snippet:  
*Replace `{bot_id}` with your value*
```xml
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLSchemes</key>
<array>
<string>tgbot{bot_id}</string>
</array>
</dict>
</array>
<key>LSApplicationQueriesSchemes</key>
<array>
<string>tg</string>
</array>
```
#### Connect AppDelegate methods
Add this code to your `UIApplicationDelegate` implementation
```objc
#import <TGPassportKit/TGPAppDelegate.h>

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
    BOOL handledByPassportKit = [[TGPAppDelegate sharedDelegate] application:application
                                                                     openURL:url
                                                                     options:options];
    return YES;
}
```
If you support iOS 9 and below, also add this method:
```objc
- (BOOL)application:(UIApplication *)application 
            openURL:(NSURL *)url 
  sourceApplication:(nullable NSString *)sourceApplication 
         annotation:(id)annotation {
    BOOL handledByPassportKit = [[TGPAppDelegate sharedDelegate] application:application
                                                                     openURL:url
                                                           sourceApplication:sourceApplication
                                                                  annotation:annotation];
    return YES;
}
```
### Usage
#### Add Telegram Passport Button
To add the Telegram Passport button, add the following code to your view controller:  
*Replace `{bot_id}`, `{bot_public_key}` and `{request_nonce}` with your values*
```objc
#import <TGPassportKit/TGPButton.h>

@interface ViewController <TGPButtonDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

TGPButton *button = [[TGPButton alloc] init];
    button.botConfig = [[TGPBotConfig alloc] initWithBotId:{bot_id} 
                                                 publicKey:@"{bot_public_key}"];
    button.scope = [[TGPScope alloc] initWithJSONString:@"{\"data\":[\"id_document\",\"address_document\",\"phone_number\"],\"v\":1}"];
    // You can also construct a scope using provided data type classes like this: 
    // button.scope = [[TGPScope alloc] initWithTypes:@[[[TGPPersonalDetails alloc] init], [[TGPIdentityDocument alloc] initWithType:TGPIdentityDocumentTypePassport selfie:true translation:true]]];
    button.nonce = @"{request_nonce}";
    button.delegate = self;
    [self.view addSubview:button];
}

- (void)passportButton:(TGPButton *)passportButton 
 didCompleteWithResult:(TGPRequestResult)result 
                 error:(NSError *)error {
    switch (result) {
        case TGPRequestResultSucceed:
            NSLog(@"Succeed");
            break;

case TGPRequestResultCancelled:
            NSLog(@"Cancelled");
            break;

default:
            NSLog(@"Failed");
            break;
    }
}

@end
```
#### ...or Implement Your Own Behavior
If you want to design a custom UI and behavior, you can invoke a Passport request like this:  
*Replace `{bot_id}`, `{bot_public_key}` and `{request_nonce}` with your values*
```objc
#import <TGPassportKit/TGPRequest.h>

- (void)performPassportRequest {
    TGPBotConfig *botConfig = [[TGPBotConfig alloc] initWithBotId:{bot_id} 
                                                        publicKey:@"{bot_public_key}"];
    TGPRequest *request = [[TGPRequest alloc] initWithBotConfig:botConfig];
    [request performWithScope:[[TGPScope alloc] initWithJSONString:@"{\"data\":[\"id_document\",\"phone_number\"],\"v\":1}"]
                        nonce:@"{request_nonce}" 
            completionHandler:^(TGPRequestResult result, NSError * _Nullable error) {
        switch (result) {
            case TGPRequestResultSucceed:
                NSLog(@"Succeed");
                break;

case TGPRequestResultCancelled:
                NSLog(@"Cancelled");
                break;

default:
                NSLog(@"Failed");
                break;
        }
    }];
}
```
## License

TGPassportKit is available under the MIT license. See the LICENSE file for more info.

TGPassportKit

TGPassportKit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

TGPassportKit

TGPassportKit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README