Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Swiftgram/TDLibFramework
TDLib for iOS, macOS, watchOS, tvOS and visionOS packed in XCFramework and SPM.
https://github.com/Swiftgram/TDLibFramework
flutter-ios ios macos swift tdlib tdlib-flutter tdlib-swift telegram tvos visionos watchos
Last synced: 17 days ago
JSON representation
TDLib for iOS, macOS, watchOS, tvOS and visionOS packed in XCFramework and SPM.
- Host: GitHub
- URL: https://github.com/Swiftgram/TDLibFramework
- Owner: Swiftgram
- License: mit
- Created: 2021-07-07T21:05:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T11:34:00.000Z (7 months ago)
- Last Synced: 2024-04-02T12:49:53.359Z (7 months ago)
- Topics: flutter-ios, ios, macos, swift, tdlib, tdlib-flutter, tdlib-swift, telegram, tvos, visionos, watchos
- Language: Swift
- Homepage:
- Size: 24.7 MB
- Stars: 13
- Watchers: 0
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TDLibFramework
[](https://github.com/Swiftgram/TDLibFramework/actions/workflows/ci.yml)
Project contains pre-compiled [TDLib](https://github.com/tdlib/td) binary for iOS, macOS, watchOS, tvOS, visionOS and simulators in `.xcframework` bundle.
If you're looking for pure Swift library, check out [TDLibKit](https://github.com/Swiftgram/TDLibKit)
## Installation
### Xcode (SPM)
1. Install latest Xcode
2. Add `https://github.com/Swiftgram/TDLibFramework` as SPM dependency in `Project > Swift Packages`.
This could take a while cause it downloads ~300mb zip file with xcframework.
3. Add `TDLibFramework` as your target dependency.
4. Code!
### Cocoapods & Flutter
See the [docs](docs/COCOAPODS-and-FLUTTER.md)
## Usage
Simple examples can be found in [Tests](Tests) directory.
### Create client
```swift
let clientId: Int32 = td_create_client_id()
```
### Make request object
```swift
let request = ["@type": "getTextEntities", "text": "@telegram /test_command https://telegram.org telegram.me", "@extra": ["5", 7.0, "\\u00e4"]] as [String: Any]
```
### JSON Serialization and Deserialization
Small example for helper functions you will need to talk with TDLib
```swift
func dictToJSONString(_ dictionary: [String: Any]) -> String {
let dictionaryData = try! JSONSerialization.data(withJSONObject: dictionary)
return String(data: dictionaryData, encoding: .utf8)!
}
func JSONStringToDict(_ string: String) -> [String: Any] {
let responseData = string.data(using: .utf8)!
return try! JSONSerialization.jsonObject(with: responseData, options: .allowFragments) as! [String: Any]
}
```
### Synchronious requests
Only for methods with "[Can be called synchronously](https://github.com/tdlib/td/blob/73d8fb4b3584633b0ffde97a20bbff6602e7a5c4/td/generate/scheme/td_api.tl#L4294)" in docs
```swift
if let res = td_execute(dictToJSONString(request)) {
let responseString = String(cString: res)
let responseDict = JSONStringToDict(responseString)
print("Response from TDLib \(responseDict)")
}
```
### Async requests
```swift
let request = [
"@type": "setTdlibParameters",
"api_hash": "5e6d7b36f0e363cf0c07baf2deb26076",
"api_id": 287311,
"application_version": "1.0",
"database_directory": "tdlib",
"database_encryption_key": nil,
"device_model": "iOS",
"enable_storage_optimizer": true,
"files_directory": "",
"ignore_file_names": true,
"system_language_code": "en",
"system_version": "Unknown",
"use_chat_info_database": true,
"use_file_database": true,
"use_message_database": true,
"use_secret_chats": true,
"use_test_dc": false,
] as [String: Any]
// Send request
td_send(clientId, dictToJSONString(request))
// Block thread and wait for response (not more 5.0 seconds)
if let response = td_receive(5.0) {
let responseString = String(cString: res)
let responseDict = JSONStringToDict(responseString)
print("Async response from TDLib \(responseDict)")
}
```
Close client on exit
```swift
td_send(clientId, dictToJSONString(["@type": "Close"] as [String: String]))
```
## Releases
You can find latest releases at [Releases](https://github.com/Swiftgram/TDLibFramework/releases) page.
## Build
You can find more about build process in [Github Actions](.github/workflows/ci.yml) file.
## Contribute
Editing `builder/Project.swift` requires [tuist](https://tuist.io/). See [installation](https://docs.tuist.io/documentation/tuist/installation) instructions for more info.
Tuist's main distribution channel is the [mise](https://mise.jdx.dev/) tool. Check their [installation](https://mise.jdx.dev/getting-started.html) steps as well
```shell
mise install tuist
```
```shell
cd builder
tuist edit
```
## Credits
- Anton Glezman for [Build Guide](https://github.com/modestman/tdlib-swift) and basic implementation
- Telegram Team for [TDLib](https://github.com/tdlib/td)
## License
[MIT](LICENSE)