Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arpit2438735/nativescript-tglib
Telegram Database Library in Nativescript
https://github.com/arpit2438735/nativescript-tglib
Last synced: about 1 month ago
JSON representation
Telegram Database Library in Nativescript
- Host: GitHub
- URL: https://github.com/arpit2438735/nativescript-tglib
- Owner: arpit2438735
- License: apache-2.0
- Created: 2018-12-10T15:25:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-19T11:48:44.000Z (almost 6 years ago)
- Last Synced: 2024-09-17T08:51:48.081Z (3 months ago)
- Language: C
- Size: 2 MB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nativescript Tglib 
Nativescript Library for building Telegram clients
## Installation
Describe your plugin installation steps. Ideally it would be something like:
```javascript
tns plugin add nativescript-tglib
```
## Features
- Currently support for iOS
- Android coming soon
---
### APIs
tglib provide some useful methods that makes your Telegram app development easier.
Most API classes/methods can be found in the official [TDLib documentation](https://core.telegram.org/tdlib/docs/classes.html).
#### Authorizing an user
```js
const client = new TDJSON({
apiId: 'YOUR_API_ID',
apiHash: 'YOUR_API_HASH',
auth: {
type: 'user',
value: 'YOUR_PHONE_NUMBER',
},
})
```
#### Authorizing a bot
```js
const client = new TDJSON({
apiId: 'YOUR_API_ID',
apiHash: 'YOUR_API_HASH',
auth: {
type: 'bot',
value: 'YOUR_BOT_TOKEN',
},
})
```
####  Low Level APIs
##### `client.ready`
This promise is used for initializing tglib client and connect with Telegram.
```js
await client.ready
```
##### `client.registerCallback(key, callback)` -> Void
This API is provided by tglib, you can use this API to register your function in order to receive callbacks.
The authorization process can be overridden here by registering `td:getInput` callback.
```js
client.registerCallback('td:update', (update) => console.log(update))
client.registerCallback('td:error', (error) => console.error(error))
client.registerCallback('td:getInput', async (args) => {
const result = await getInputFromUser(args)
return result
})
```
##### `client.fetch(query)` -> Promise -> Object
This API is provided by tglib, you can use this API to send asynchronous message to Telegram and receive response.
```js
const chats = await client.fetch({
'@type': 'getChats',
'offset_order': '9223372036854775807',
'offset_chat_id': 0,
'limit': 100,
})
```
##### `client.send(query)` -> Promise -> Object
This API is provided by TDLib, you can use this API to send asynchronous message to Telegram.
```js
await client.send({
'@type': 'sendMessage',
'chat_id': -123456789,
'input_message_content': {
'@type': 'inputMessageText',
'text': {
'@type': 'formattedText',
'text': '👻',
},
},
})
```
## License
Apache License Version 2.0, January 2004