mirror of
https://github.com/danog/tg-file-decoder.git
synced 2024-11-26 12:24:40 +01:00
Bump docs
This commit is contained in:
parent
b6fef5ec62
commit
49f8b8256a
99
docs/danog/Decoder/FileId.md
Normal file
99
docs/danog/Decoder/FileId.md
Normal file
@ -0,0 +1,99 @@
|
||||
---
|
||||
title: "danog\\Decoder\\FileId: Represents decoded bot API file ID."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\FileId`
|
||||
[Back to index](../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents decoded bot API file ID.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$dcId`: `int` DC ID.
|
||||
* `$type`: `\danog\Decoder\FileIdType` File type.
|
||||
* `$id`: `?int` File id.
|
||||
* `$accessHash`: `int` File access hash.
|
||||
* `$photoSizeSource`: `?\danog\Decoder\PhotoSizeSource` Photo size source.
|
||||
* `$volumeId`: `?int` Photo volume ID.
|
||||
* `$localId`: `?int` Photo local ID.
|
||||
* `$fileReference`: `?string` File reference.
|
||||
* `$url`: `?string` File URL for weblocation.
|
||||
* `$version`: `int` Bot API file ID version.
|
||||
* `$subVersion`: `int` Bot API file ID subversion.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(int $dcId, \danog\Decoder\FileIdType $type, ?int $id, int $accessHash, ?\danog\Decoder\PhotoSizeSource $photoSizeSource = NULL, ?int $volumeId = NULL, ?int $localId = NULL, ?string $fileReference = NULL, ?string $url = NULL, int $version = 4, int $subVersion = 47)`](#__construct-int-dcid-danog-decoder-fileidtype-type-int-id-int-accesshash-danog-decoder-photosizesource-photosizesource-null-int-volumeid-null-int-localid-null-string-filereference-null-string-url-null-int-version-4-int-subversion-47)
|
||||
* [`fromBotAPI(string $fileId): self`](#frombotapi-string-fileid-self)
|
||||
* [`getBotAPI(): string`](#getbotapi-string)
|
||||
* [`getUnique(): \danog\Decoder\UniqueFileId`](#getunique-danog-decoder-uniquefileid)
|
||||
* [`getUniqueBotAPI(): string`](#getuniquebotapi-string)
|
||||
|
||||
## Methods:
|
||||
### `__construct(int $dcId, \danog\Decoder\FileIdType $type, ?int $id, int $accessHash, ?\danog\Decoder\PhotoSizeSource $photoSizeSource = NULL, ?int $volumeId = NULL, ?int $localId = NULL, ?string $fileReference = NULL, ?string $url = NULL, int $version = 4, int $subVersion = 47)`
|
||||
|
||||
Basic constructor function.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$dcId`: `int`
|
||||
* `$type`: `\danog\Decoder\FileIdType`
|
||||
* `$id`: `?int`
|
||||
* `$accessHash`: `int`
|
||||
* `$photoSizeSource`: `?\danog\Decoder\PhotoSizeSource`
|
||||
* `$volumeId`: `?int`
|
||||
* `$localId`: `?int`
|
||||
* `$fileReference`: `?string`
|
||||
* `$url`: `?string`
|
||||
* `$version`: `int`
|
||||
* `$subVersion`: `int`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\FileIdType`: Represents decoded bot API file ID type.](../../danog/Decoder/FileIdType.md)
|
||||
* [`\danog\Decoder\PhotoSizeSource`: Represents source of photosize.](../../danog/Decoder/PhotoSizeSource.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `fromBotAPI(string $fileId): self`
|
||||
|
||||
Decode file ID from bot API file ID.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$fileId`: `string` File ID
|
||||
|
||||
|
||||
|
||||
### `getBotAPI(): string`
|
||||
|
||||
Get bot API file ID.
|
||||
|
||||
|
||||
|
||||
### `getUnique(): \danog\Decoder\UniqueFileId`
|
||||
|
||||
Get unique file ID from file ID.
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\UniqueFileId`: Represents decoded unique bot API file ID.](../../danog/Decoder/UniqueFileId.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `getUniqueBotAPI(): string`
|
||||
|
||||
Get unique bot API file ID from file ID.
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
126
docs/danog/Decoder/FileIdType.md
Normal file
126
docs/danog/Decoder/FileIdType.md
Normal file
@ -0,0 +1,126 @@
|
||||
---
|
||||
title: "danog\\Decoder\\FileIdType: Represents decoded bot API file ID type."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\FileIdType`
|
||||
[Back to index](../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents decoded bot API file ID type.
|
||||
|
||||
|
||||
|
||||
|
||||
## Constants
|
||||
* `danog\Decoder\FileIdType::THUMBNAIL`: Thumbnail.
|
||||
|
||||
* `danog\Decoder\FileIdType::PROFILE_PHOTO`: Profile photo.
|
||||
|
||||
Used for users and channels, chat photos are normal PHOTOs.
|
||||
|
||||
* `danog\Decoder\FileIdType::PHOTO`: Normal photos.
|
||||
|
||||
* `danog\Decoder\FileIdType::VOICE`: Voice messages.
|
||||
|
||||
* `danog\Decoder\FileIdType::VIDEO`: Video.
|
||||
|
||||
* `danog\Decoder\FileIdType::DOCUMENT`: Document.
|
||||
|
||||
* `danog\Decoder\FileIdType::ENCRYPTED`: Secret chat document.
|
||||
|
||||
* `danog\Decoder\FileIdType::TEMP`: Temporary document.
|
||||
|
||||
* `danog\Decoder\FileIdType::STICKER`: Sticker.
|
||||
|
||||
* `danog\Decoder\FileIdType::AUDIO`: Music.
|
||||
|
||||
* `danog\Decoder\FileIdType::ANIMATION`: GIF.
|
||||
|
||||
* `danog\Decoder\FileIdType::ENCRYPTED_THUMBNAIL`: Encrypted thumbnail.
|
||||
|
||||
* `danog\Decoder\FileIdType::WALLPAPER`: Wallpaper.
|
||||
|
||||
* `danog\Decoder\FileIdType::VIDEO_NOTE`: Round video.
|
||||
|
||||
* `danog\Decoder\FileIdType::SECURE_RAW`: Passport raw file.
|
||||
|
||||
* `danog\Decoder\FileIdType::SECURE`: Passport file.
|
||||
|
||||
* `danog\Decoder\FileIdType::BACKGROUND`: Background.
|
||||
|
||||
* `danog\Decoder\FileIdType::SIZE`: Size.
|
||||
|
||||
## Properties
|
||||
* `$name`: `string`
|
||||
* `$value`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`fromBotApiType(string $type): self`](#frombotapitype-string-type-self)
|
||||
* [`toBotApiType(): string`](#tobotapitype-string)
|
||||
* [`toUnique(): \danog\Decoder\UniqueFileIdType`](#tounique-danog-decoder-uniquefileidtype)
|
||||
* [`cases(): array`](#cases-array)
|
||||
* [`from(string|int $value): static`](#from-string-int-value-static)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static)
|
||||
|
||||
## Methods:
|
||||
### `fromBotApiType(string $type): self`
|
||||
|
||||
Obtain a FileId enum variant from a bot API type name.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$type`: `string`
|
||||
|
||||
|
||||
|
||||
### `toBotApiType(): string`
|
||||
|
||||
Obtain a bot API type name.
|
||||
|
||||
|
||||
|
||||
### `toUnique(): \danog\Decoder\UniqueFileIdType`
|
||||
|
||||
Convert file ID type to unique file ID type.
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\UniqueFileIdType`: Represents decoded unique bot API file ID type.](../../danog/Decoder/UniqueFileIdType.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `cases(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `from(string|int $value): static`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$value`: `string|int`
|
||||
|
||||
|
||||
|
||||
### `tryFrom(string|int $value): ?static`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$value`: `string|int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
17
docs/danog/Decoder/PhotoSizeSource.md
Normal file
17
docs/danog/Decoder/PhotoSizeSource.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource`
|
||||
[Back to index](../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceDialogPhoto: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhoto`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`__construct(int $dialogId, int $dialogAccessHash)`](#__construct-int-dialogid-int-dialogaccesshash)
|
||||
* [`isSmallDialogPhoto(): bool`](#issmalldialogphoto-bool)
|
||||
|
||||
## Methods:
|
||||
### `__construct(int $dialogId, int $dialogAccessHash)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
|
||||
|
||||
### `isSmallDialogPhoto(): bool`
|
||||
|
||||
Get whether the big or small version of the photo is being used.
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceDialogPhotoBig: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhotoBig`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`isSmallDialogPhoto(): bool`](#issmalldialogphoto-bool)
|
||||
* [`__construct(int $dialogId, int $dialogAccessHash)`](#__construct-int-dialogid-int-dialogaccesshash)
|
||||
|
||||
## Methods:
|
||||
### `isSmallDialogPhoto(): bool`
|
||||
|
||||
Get whether the big or small version of the photo is being used.
|
||||
|
||||
|
||||
|
||||
### `__construct(int $dialogId, int $dialogAccessHash)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceDialogPhotoSmall: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhotoSmall`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`isSmallDialogPhoto(): bool`](#issmalldialogphoto-bool)
|
||||
* [`__construct(int $dialogId, int $dialogAccessHash)`](#__construct-int-dialogid-int-dialogaccesshash)
|
||||
|
||||
## Methods:
|
||||
### `isSmallDialogPhoto(): bool`
|
||||
|
||||
Get whether the big or small version of the photo is being used.
|
||||
|
||||
|
||||
|
||||
### `__construct(int $dialogId, int $dialogAccessHash)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$dialogId`: `int`
|
||||
* `$dialogAccessHash`: `int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
35
docs/danog/Decoder/PhotoSizeSource/PhotoSizeSourceLegacy.md
Normal file
35
docs/danog/Decoder/PhotoSizeSource/PhotoSizeSourceLegacy.md
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceLegacy: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceLegacy`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$secret`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`__construct(int $secret)`](#__construct-int-secret)
|
||||
|
||||
## Methods:
|
||||
### `__construct(int $secret)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$secret`: `int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceStickersetThumbnail: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceStickersetThumbnail`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$stickerSetId`: `int` Stickerset ID.
|
||||
* `$stickerSetAccessHash`: `int` Stickerset access hash.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(int $stickerSetId, int $stickerSetAccessHash)`](#__construct-int-stickersetid-int-stickersetaccesshash)
|
||||
|
||||
## Methods:
|
||||
### `__construct(int $stickerSetId, int $stickerSetAccessHash)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$stickerSetId`: `int`
|
||||
* `$stickerSetAccessHash`: `int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceStickersetThumbnailVersion: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceStickersetThumbnailVersion`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$stickerSetId`: `int` Stickerset ID.
|
||||
* `$stickerSetAccessHash`: `int` Stickerset access hash.
|
||||
* `$stickerSetVersion`: `int` Stickerset version.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(int $stickerSetId, int $stickerSetAccessHash, int $stickerSetVersion)`](#__construct-int-stickersetid-int-stickersetaccesshash-int-stickersetversion)
|
||||
|
||||
## Methods:
|
||||
### `__construct(int $stickerSetId, int $stickerSetAccessHash, int $stickerSetVersion)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$stickerSetId`: `int`
|
||||
* `$stickerSetAccessHash`: `int`
|
||||
* `$stickerSetVersion`: `int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
@ -0,0 +1,42 @@
|
||||
---
|
||||
title: "danog\\Decoder\\PhotoSizeSource\\PhotoSizeSourceThumbnail: Represents source of photosize."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\PhotoSizeSource\PhotoSizeSourceThumbnail`
|
||||
[Back to index](../../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents source of photosize.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$thumbFileType`: `\danog\Decoder\FileIdType` File type of original file.
|
||||
* `$thumbType`: `string` Thumbnail size.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\danog\Decoder\FileIdType $thumbFileType, string $thumbType)`](#__construct-danog-decoder-fileidtype-thumbfiletype-string-thumbtype)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\danog\Decoder\FileIdType $thumbFileType, string $thumbType)`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$thumbFileType`: `\danog\Decoder\FileIdType`
|
||||
* `$thumbType`: `string`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\FileIdType`: Represents decoded bot API file ID type.](../../../danog/Decoder/FileIdType.md)
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
102
docs/danog/Decoder/UniqueFileId.md
Normal file
102
docs/danog/Decoder/UniqueFileId.md
Normal file
@ -0,0 +1,102 @@
|
||||
---
|
||||
title: "danog\\Decoder\\UniqueFileId: Represents decoded unique bot API file ID."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\UniqueFileId`
|
||||
[Back to index](../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents decoded unique bot API file ID.
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
* `$type`: `\danog\Decoder\UniqueFileIdType` File type.
|
||||
* `$id`: `?int` File ID.
|
||||
* `$subType`: `?int` Photo subtype.
|
||||
* `$volumeId`: `?int` Photo volume ID.
|
||||
* `$localId`: `?int` Photo local ID.
|
||||
* `$stickerSetId`: `?int` Sticker set ID.
|
||||
* `$stickerSetVersion`: `?int` Sticker set version.
|
||||
* `$url`: `?string` Weblocation URL.
|
||||
|
||||
## Method list:
|
||||
* [`__construct(\danog\Decoder\UniqueFileIdType $type, ?int $id = NULL, ?int $subType = NULL, ?int $volumeId = NULL, ?int $localId = NULL, ?int $stickerSetId = NULL, ?int $stickerSetVersion = NULL, ?string $url = NULL)`](#__construct-danog-decoder-uniquefileidtype-type-int-id-null-int-subtype-null-int-volumeid-null-int-localid-null-int-stickersetid-null-int-stickersetversion-null-string-url-null)
|
||||
* [`getUniqueBotAPI(): string`](#getuniquebotapi-string)
|
||||
* [`fromUniqueBotAPI(string $fileId): self`](#fromuniquebotapi-string-fileid-self)
|
||||
* [`fromBotAPI(string $fileId): self`](#frombotapi-string-fileid-self)
|
||||
* [`fromFileId(\danog\Decoder\FileId $fileId): self`](#fromfileid-danog-decoder-fileid-fileid-self)
|
||||
|
||||
## Methods:
|
||||
### `__construct(\danog\Decoder\UniqueFileIdType $type, ?int $id = NULL, ?int $subType = NULL, ?int $volumeId = NULL, ?int $localId = NULL, ?int $stickerSetId = NULL, ?int $stickerSetVersion = NULL, ?string $url = NULL)`
|
||||
|
||||
Basic constructor function.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$type`: `\danog\Decoder\UniqueFileIdType`
|
||||
* `$id`: `?int`
|
||||
* `$subType`: `?int`
|
||||
* `$volumeId`: `?int`
|
||||
* `$localId`: `?int`
|
||||
* `$stickerSetId`: `?int`
|
||||
* `$stickerSetVersion`: `?int`
|
||||
* `$url`: `?string`
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\UniqueFileIdType`: Represents decoded unique bot API file ID type.](../../danog/Decoder/UniqueFileIdType.md)
|
||||
|
||||
|
||||
|
||||
|
||||
### `getUniqueBotAPI(): string`
|
||||
|
||||
Get unique bot API file ID.
|
||||
|
||||
|
||||
|
||||
### `fromUniqueBotAPI(string $fileId): self`
|
||||
|
||||
Decode unique bot API file ID.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$fileId`: `string` Bot API file ID
|
||||
|
||||
|
||||
|
||||
### `fromBotAPI(string $fileId): self`
|
||||
|
||||
Convert full bot API file ID to unique file ID.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$fileId`: `string` Full bot API file ID
|
||||
|
||||
|
||||
|
||||
### `fromFileId(\danog\Decoder\FileId $fileId): self`
|
||||
|
||||
Turn full file ID into unique file ID.
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$fileId`: `\danog\Decoder\FileId` Full file ID
|
||||
|
||||
|
||||
#### See also:
|
||||
* [`\danog\Decoder\FileId`: Represents decoded bot API file ID.](../../danog/Decoder/FileId.md)
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
69
docs/danog/Decoder/UniqueFileIdType.md
Normal file
69
docs/danog/Decoder/UniqueFileIdType.md
Normal file
@ -0,0 +1,69 @@
|
||||
---
|
||||
title: "danog\\Decoder\\UniqueFileIdType: Represents decoded unique bot API file ID type."
|
||||
description: ""
|
||||
|
||||
---
|
||||
# `danog\Decoder\UniqueFileIdType`
|
||||
[Back to index](../../index.md)
|
||||
|
||||
> Author: Daniil Gentili <daniil@daniil.it>
|
||||
|
||||
|
||||
Represents decoded unique bot API file ID type.
|
||||
|
||||
|
||||
|
||||
|
||||
## Constants
|
||||
* `danog\Decoder\UniqueFileIdType::WEB`:
|
||||
|
||||
* `danog\Decoder\UniqueFileIdType::PHOTO`:
|
||||
|
||||
* `danog\Decoder\UniqueFileIdType::DOCUMENT`:
|
||||
|
||||
* `danog\Decoder\UniqueFileIdType::SECURE`:
|
||||
|
||||
* `danog\Decoder\UniqueFileIdType::ENCRYPTED`:
|
||||
|
||||
* `danog\Decoder\UniqueFileIdType::TEMP`:
|
||||
|
||||
## Properties
|
||||
* `$name`: `string`
|
||||
* `$value`: `int`
|
||||
|
||||
## Method list:
|
||||
* [`cases(): array`](#cases-array)
|
||||
* [`from(string|int $value): static`](#from-string-int-value-static)
|
||||
* [`tryFrom(string|int $value): ?static`](#tryfrom-string-int-value-static)
|
||||
|
||||
## Methods:
|
||||
### `cases(): array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `from(string|int $value): static`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$value`: `string|int`
|
||||
|
||||
|
||||
|
||||
### `tryFrom(string|int $value): ?static`
|
||||
|
||||
|
||||
|
||||
|
||||
Parameters:
|
||||
|
||||
* `$value`: `string|int`
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
|
||||
31
docs/index.md
Normal file
31
docs/index.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
description: "Decode Telegram bot API file IDs"
|
||||
title: "danog/tg-file-decoder"
|
||||
|
||||
---
|
||||
# `danog/tg-file-decoder`
|
||||
|
||||
Decode Telegram bot API file IDs
|
||||
|
||||
|
||||
|
||||
## Abstract classes
|
||||
* [\danog\Decoder\PhotoSizeSource: Represents source of photosize.](danog/Decoder/PhotoSizeSource.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhoto: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceDialogPhoto.md)
|
||||
|
||||
## Classes
|
||||
* [\danog\Decoder\FileId: Represents decoded bot API file ID.](danog/Decoder/FileId.md)
|
||||
* [\danog\Decoder\FileIdType: Represents decoded bot API file ID type.](danog/Decoder/FileIdType.md)
|
||||
* [\danog\Decoder\UniqueFileId: Represents decoded unique bot API file ID.](danog/Decoder/UniqueFileId.md)
|
||||
* [\danog\Decoder\UniqueFileIdType: Represents decoded unique bot API file ID type.](danog/Decoder/UniqueFileIdType.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhotoBig: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceDialogPhotoBig.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceDialogPhotoSmall: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceDialogPhotoSmall.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceLegacy: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceLegacy.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceStickersetThumbnail: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceStickersetThumbnail.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceStickersetThumbnailVersion: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceStickersetThumbnailVersion.md)
|
||||
* [\danog\Decoder\PhotoSizeSource\PhotoSizeSourceThumbnail: Represents source of photosize.](danog/Decoder/PhotoSizeSource/PhotoSizeSourceThumbnail.md)
|
||||
|
||||
|
||||
|
||||
---
|
||||
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
|
||||
Loading…
Reference in New Issue
Block a user