MadelineProtoDocs/old_docs/API_docs_v27/methods/photos.getUserPhotos.md

59 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: photos.getUserPhotos
2019-12-27 17:48:04 +01:00
description: Returns the list of user photos.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/photos_getUserPhotos.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: photos.getUserPhotos
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
2019-12-27 17:48:04 +01:00
Returns the list of user photos.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional|
|offset|[int](../types/int.md) | Number of list elements to be skipped | Yes|
2020-06-16 17:50:25 +02:00
|max\_id|[long](../types/long.md) | If a positive value was transferred, the method will return only photos with IDs less than the set one | Yes|
2019-12-27 17:48:04 +01:00
|limit|[int](../types/int.md) | Number of list elements to be returned | Yes|
2018-04-01 13:19:25 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [photos.Photos](../types/photos.Photos.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **YES**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-06-16 17:50:25 +02:00
$photos.Photos = $MadelineProto->photos->getUserPhotos(['user_id' => InputUser, 'offset' => int, 'max_id' => long, 'limit' => int, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
photos.Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|MAX_ID_INVALID|The provided max ID is invalid|
|400|USER_ID_INVALID|The provided user ID is invalid|
2020-06-16 17:50:25 +02:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2018-04-01 13:19:25 +02:00