Skip to content

Commit

Permalink
Bump docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danog committed Apr 1, 2024
1 parent b6fef5e commit 49f8b82
Show file tree
Hide file tree
Showing 13 changed files with 729 additions and 0 deletions.
99 changes: 99 additions & 0 deletions docs/danog/Decoder/FileId.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>

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 changes: 126 additions & 0 deletions docs/danog/Decoder/FileIdType.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>

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 changes: 17 additions & 0 deletions docs/danog/Decoder/PhotoSizeSource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "danog\\Decoder\\PhotoSizeSource: Represents source of photosize."
description: ""

---
# `danog\Decoder\PhotoSizeSource`
[Back to index](../../index.md)

> Author: Daniil Gentili <[email protected]>

Represents source of photosize.



---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
44 changes: 44 additions & 0 deletions docs/danog/Decoder/PhotoSizeSource/PhotoSizeSourceDialogPhoto.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>

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)
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>

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)
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>

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)
Loading

0 comments on commit 49f8b82

Please sign in to comment.