telegram-bot-api/docs/getting-started/files.md

69 lines
1.8 KiB
Markdown
Raw Normal View History

2020-07-27 00:22:16 +02:00
# Files
Telegram supports specifying files in many different formats. In order to
accommodate them all, there are multiple structs and type aliases required.
2021-08-20 22:15:37 +02:00
All of these types implement the `RequestFileData` interface.
2021-03-10 22:36:15 +01:00
| Type | Description |
| ------------ | ------------------------------------------------------------------------- |
2021-08-20 22:15:37 +02:00
| `FilePath` | A local path to a file |
2021-03-10 22:36:15 +01:00
| `FileID` | Existing file ID on Telegram's servers |
| `FileURL` | URL to file, must be served with expected MIME type |
| `FileReader` | Use an `io.Reader` to provide a file. Lazily read to save memory. |
| `FileBytes` | `[]byte` containing file data. Prefer to use `FileReader` to save memory. |
2020-07-27 00:22:16 +02:00
2021-08-20 22:15:37 +02:00
## `FilePath`
2020-07-27 00:22:16 +02:00
A path to a local file.
```go
2021-08-20 22:15:37 +02:00
file := tgbotapi.FilePath("tests/image.jpg")
2020-07-27 00:22:16 +02:00
```
## `FileID`
An ID previously uploaded to Telegram. IDs may only be reused by the same bot
that received them. Additionally, thumbnail IDs cannot be reused.
```go
file := tgbotapi.FileID("AgACAgIAAxkDAALesF8dCjAAAa_…")
```
## `FileURL`
A URL to an existing resource. It must be served with a correct MIME type to
work as expected.
```go
file := tgbotapi.FileURL("https://i.imgur.com/unQLJIb.jpg")
```
## `FileReader`
Use an `io.Reader` to provide file contents as needed. Requires a filename for
the virtual file.
```go
var reader io.Reader
file := tgbotapi.FileReader{
Name: "image.jpg",
Reader: reader,
}
```
## `FileBytes`
Use a `[]byte` to provide file contents. Generally try to avoid this as it
results in high memory usage. Also requires a filename for the virtual file.
```go
var data []byte
file := tgbotapi.FileBytes{
Name: "image.jpg",
Bytes: data,
}
```