Docs improvements
This commit is contained in:
parent
55b64aaf62
commit
8dee62b19a
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: accountTtl
|
||||
description: Contains information about period of inactivity, after which the account of currently logged in user will be automatically deleted
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: accountTtl
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains information about period of inactivity, after which the account of currently logged in user will be automatically deleted
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|days|[int](../types/int.md) | Yes|Number of days of inactivity before account deletion, should be from 30 and up to 366|
|
||||
|
||||
|
||||
|
||||
### Type: [AccountTtl](../types/AccountTtl.md)
|
||||
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
---
|
||||
title: animation
|
||||
description: Describes animation file. Animation should be encoded in gif or mp4 format
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: animation
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Describes animation file. Animation should be encoded in gif or mp4 format
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|duration|[int](../types/int.md) | Yes|Duration of the animation in seconds as defined by sender|
|
||||
|width|[int](../types/int.md) | Yes|Width of the animation|
|
||||
|height|[int](../types/int.md) | Yes|Height of the animation|
|
||||
|file\_name|[string](../types/string.md) | Yes|Original name of a file as defined by sender|
|
||||
|mime\_type|[string](../types/string.md) | Yes|MIME type of a file, usually "image/gif" or "video/mp4"|
|
||||
|thumb|[photoSize](../constructors/photoSize.md) | Yes|Animation thumb, nullable|
|
||||
|animation|[file](../constructors/file.md) | Yes|File with the animation|
|
||||
|
||||
|
||||
|
||||
### Type: [Animation](../types/Animation.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: animations
|
||||
description: Represents list of animations
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: animations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents list of animations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|animations|Array of [animation](../constructors/animation.md) | Yes|Animations|
|
||||
|
||||
|
||||
|
||||
### Type: [Animations](../types/Animations.md)
|
||||
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
---
|
||||
title: audio
|
||||
description: Describes audio file. Audio is usually in mp3 format
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: audio
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Describes audio file. Audio is usually in mp3 format
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|duration|[int](../types/int.md) | Yes|Duration of the audio in seconds as defined by sender|
|
||||
|title|[string](../types/string.md) | Yes|Title of the audio as defined by sender|
|
||||
|performer|[string](../types/string.md) | Yes|Performer of the audio as defined by sender|
|
||||
|file\_name|[string](../types/string.md) | Yes|Original name of a file as defined by sender|
|
||||
|mime\_type|[string](../types/string.md) | Yes|MIME type of a file as defined by sender|
|
||||
|album\_cover\_thumb|[photoSize](../constructors/photoSize.md) | Yes|Thumb of the album's cover as defined by sender. Full size thumb should be extracted from the downloaded file, nullable|
|
||||
|audio|[file](../constructors/file.md) | Yes|File with the audio|
|
||||
|
||||
|
||||
|
||||
### Type: [Audio](../types/Audio.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: authCodeTypeCall
|
||||
description: Code is delivered by phone call to the specified phone number
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authCodeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Code is delivered by phone call to the specified phone number
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthCodeType](../types/AuthCodeType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: authCodeTypeFlashCall
|
||||
description: Code is delivered by the immediately cancelled call to the specified phone number. Number from which the call was done is the code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authCodeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Code is delivered by the immediately cancelled call to the specified phone number. Number from which the call was done is the code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|pattern|[string](../types/string.md) | Yes|Pattern of the phone number from which the call will be done|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthCodeType](../types/AuthCodeType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: authCodeTypeMessage
|
||||
description: Code is delivered through private Telegram message, which can be viewed in the other client
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authCodeTypeMessage
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Code is delivered through private Telegram message, which can be viewed in the other client
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthCodeType](../types/AuthCodeType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: authCodeTypeSms
|
||||
description: Code is delivered by SMS to the specified phone number
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authCodeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Code is delivered by SMS to the specified phone number
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthCodeType](../types/AuthCodeType.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: authStateLoggingOut
|
||||
description: User is currently logging out
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authStateLoggingOut
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is currently logging out
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AuthState](../types/AuthState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: authStateOk
|
||||
description: User is successfully authorized. TDLib can answer queries
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authStateOk
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is successfully authorized. TDLib can answer queries
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AuthState](../types/AuthState.md)
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: authStateWaitCode
|
||||
description: TDLib needs user authentication code to finish authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authStateWaitCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
TDLib needs user authentication code to finish authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|is\_registered|[Bool](../types/Bool.md) | Yes|True, if user is already registered|
|
||||
|code\_type|[AuthCodeType](../types/AuthCodeType.md) | Yes|Describes the way, code was sent to the user|
|
||||
|next\_code\_type|[AuthCodeType](../types/AuthCodeType.md) | Yes|Describes the way, next code will be sent to the user, nullable|
|
||||
|timeout|[int](../types/int.md) | Yes|Timeout in seconds before code should be resent by calling resendAuthCode|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthState](../types/AuthState.md)
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: authStateWaitPassword
|
||||
description: User is authorized but he needs to enter its password to begin to use application
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authStateWaitPassword
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is authorized but he needs to enter its password to begin to use application
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|password\_hint|[string](../types/string.md) | Yes|Hint on password, can be empty|
|
||||
|has\_recovery\_email|[Bool](../types/Bool.md) | Yes|Is recovery email set up|
|
||||
|recovery\_email\_pattern|[string](../types/string.md) | Yes|Pattern of email to which recovery mail was sent, empty before recovery email was sent|
|
||||
|
||||
|
||||
|
||||
### Type: [AuthState](../types/AuthState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: authStateWaitPhoneNumber
|
||||
description: TDLib needs user's phone number to authorize
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authStateWaitPhoneNumber
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
TDLib needs user's phone number to authorize
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AuthState](../types/AuthState.md)
|
||||
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
title: boolFalse
|
||||
description: Represents a boolean with value equal to false
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolFalse
|
||||
[Back to constructor index](index.md)
|
||||
|
||||
Represents a boolean with value equal to `false`.
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
title: boolTrue
|
||||
description: Represents a boolean with value equal to true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolTrue
|
||||
[Back to constructor index](index.md)
|
||||
|
||||
Represents a boolean with value equal to `true`.
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: botCommand
|
||||
description: Represents command supported by bot
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommand
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents command supported by bot
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|command|[string](../types/string.md) | Yes|Text of the bot command|
|
||||
|description|[string](../types/string.md) | Yes|Description of the bot command|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommand](../types/BotCommand.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: botInfo
|
||||
description: Provides information about bot and command supported by him
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInfo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Provides information about bot and command supported by him
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|description|[string](../types/string.md) | Yes|Big description shown in user info page|
|
||||
|commands|Array of [botCommand](../constructors/botCommand.md) | Yes|List of commands cupported by bot|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInfo](../types/BotInfo.md)
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: call
|
||||
description: Describes a call
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: call
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Describes a call
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|Call identifier, not persistent|
|
||||
|user\_id|[int](../types/int.md) | Yes|Peer user identifier|
|
||||
|is\_outgoing|[Bool](../types/Bool.md) | Yes|True, if the call is outgoing|
|
||||
|state|[CallState](../types/CallState.md) | Yes|Call state|
|
||||
|
||||
|
||||
|
||||
### Type: [Call](../types/Call.md)
|
||||
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
---
|
||||
title: callConnection
|
||||
description: Describes address of UDP reflectors
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callConnection
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Describes address of UDP reflectors
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int64](../constructors/int64.md) | Yes|Reflector identifier|
|
||||
|ip|[string](../types/string.md) | Yes|IPv4 reflector address|
|
||||
|ipv6|[string](../types/string.md) | Yes|IPv6 reflector address|
|
||||
|port|[int](../types/int.md) | Yes|Reflector port|
|
||||
|peer\_tag|[bytes](../types/bytes.md) | Yes|Connection peer tag|
|
||||
|
||||
|
||||
|
||||
### Type: [CallConnection](../types/CallConnection.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callDiscardReasonDeclined
|
||||
description: Call has ended before conversation begins. It was declined by the callee
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callDiscardReasonDeclined
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call has ended before conversation begins. It was declined by the callee
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallDiscardReason](../types/CallDiscardReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callDiscardReasonDisconnected
|
||||
description: Call has ended during conversation because users was disconnected
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callDiscardReasonDisconnected
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call has ended during conversation because users was disconnected
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallDiscardReason](../types/CallDiscardReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callDiscardReasonEmpty
|
||||
description: Call wasn't discarded or the reason is unknown
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callDiscardReasonEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call wasn't discarded or the reason is unknown
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallDiscardReason](../types/CallDiscardReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callDiscardReasonHungUp
|
||||
description: Call was hung up by the caller or by the callee
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callDiscardReasonHungUp
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call was hung up by the caller or by the callee
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallDiscardReason](../types/CallDiscardReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callDiscardReasonMissed
|
||||
description: Call has ended before conversation begins. It was cancelled by the caller or was missed by the callee
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callDiscardReasonMissed
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call has ended before conversation begins. It was cancelled by the caller or was missed by the callee
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallDiscardReason](../types/CallDiscardReason.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: callId
|
||||
description: Contains call identifier
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callId
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains call identifier
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|Call identifier|
|
||||
|
||||
|
||||
|
||||
### Type: [CallId](../types/CallId.md)
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: callProtocol
|
||||
description: Specifies supported call protocols
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callProtocol
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Specifies supported call protocols
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|udp\_p2p|[Bool](../types/Bool.md) | Yes|True, if UDP peer to peer connections are supported|
|
||||
|udp\_reflector|[Bool](../types/Bool.md) | Yes|True, if connection through UDP reflectors are supported|
|
||||
|min\_layer|[int](../types/int.md) | Yes|Minimum supported layer, use 65|
|
||||
|max\_layer|[int](../types/int.md) | Yes|Maximum supported layer, use 65|
|
||||
|
||||
|
||||
|
||||
### Type: [CallProtocol](../types/CallProtocol.md)
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: callStateDiscarded
|
||||
description: Call has ended successfully
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStateDiscarded
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call has ended successfully
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|reason|[CallDiscardReason](../types/CallDiscardReason.md) | Optional|A reason, why call has ended|
|
||||
|need\_rating|[Bool](../types/Bool.md) | Yes|If true, call rating should be sent to the server|
|
||||
|need\_debug|[Bool](../types/Bool.md) | Yes|If true, call debug should be sent to the server|
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: callStateError
|
||||
description: Call has ended with an error
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStateError
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call has ended with an error
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|error|[error](../constructors/error.md) | Yes|The error. Error with the code 4005000 returned if an outgoing call is missed because of expired timeout|
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callStateExchangingKeys
|
||||
description: Call is answered and encryption keys are exchanged
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStateExchangingKeys
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call is answered and encryption keys are exchanged
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: callStateHangingUp
|
||||
description: Call is hanging up after discardCall is called
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStateHangingUp
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call is hanging up after discardCall is called
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: callStatePending
|
||||
description: Call is pending for acception by a user
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStatePending
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call is pending for acception by a user
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|is\_created|[Bool](../types/Bool.md) | Yes|True, if the call is already created by the server|
|
||||
|is\_received|[Bool](../types/Bool.md) | Yes|True, if the call is already received by the other party|
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
---
|
||||
title: callStateReady
|
||||
description: Call is ready to use
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callStateReady
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Call is ready to use
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|protocol|[callProtocol](../constructors/callProtocol.md) | Yes|Call protocols supported by the peer|
|
||||
|connections|Array of [callConnection](../constructors/callConnection.md) | Yes|Available UDP reflectors|
|
||||
|config|[string](../types/string.md) | Yes|JSON-encoded call config|
|
||||
|encryption\_key|[bytes](../types/bytes.md) | Yes|Call encryption key|
|
||||
|emojis|Array of [string](../types/string.md) | Yes|Encryption key emojis fingerprint|
|
||||
|
||||
|
||||
|
||||
### Type: [CallState](../types/CallState.md)
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: callbackQueryAnswer
|
||||
description: Contains answer of a bot to a callback query
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callbackQueryAnswer
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains answer of a bot to a callback query
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|text|[string](../types/string.md) | Yes|Text of the answer|
|
||||
|show\_alert|[Bool](../types/Bool.md) | Yes|If true, an alert should be shown to the user instead of a toast|
|
||||
|url|[string](../types/string.md) | Yes|URL to be open|
|
||||
|
||||
|
||||
|
||||
### Type: [CallbackQueryAnswer](../types/CallbackQueryAnswer.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: callbackQueryPayloadData
|
||||
description: Payload from a general callback button
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callbackQueryPayloadData
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Payload from a general callback button
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|data|[bytes](../types/bytes.md) | Yes|Data that was attached to the callback button|
|
||||
|
||||
|
||||
|
||||
### Type: [CallbackQueryPayload](../types/CallbackQueryPayload.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: callbackQueryPayloadGame
|
||||
description: Payload from a game callback button
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: callbackQueryPayloadGame
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Payload from a game callback button
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|game\_short\_name|[string](../types/string.md) | Yes|Short name of the game that was attached to the callback button|
|
||||
|
||||
|
||||
|
||||
### Type: [CallbackQueryPayload](../types/CallbackQueryPayload.md)
|
||||
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: channel
|
||||
description: Represents a channel with zero or more subscribers. There two different kinds of channels: supergroups and broadcast channels
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channel
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents a channel with zero or more subscribers. There two different kinds of channels: supergroups and broadcast channels
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|Channel identifier|
|
||||
|username|[string](../types/string.md) | Yes|Channel username, empty for private channels|
|
||||
|date|[int](../types/int.md) | Yes|Date when current user has joined the channel or date when channel was created, if user is not a member. Unix time|
|
||||
|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Status of the current user in the channel|
|
||||
|anyone\_can\_invite|[Bool](../types/Bool.md) | Yes|True, if any member of the supergroup can invite other members. If the channel is not a supergroup, the field is meaningless|
|
||||
|sign\_messages|[Bool](../types/Bool.md) | Yes|True, if messages sent to the channel should content information about the sender. If the channel is a supergroup, the field is meaningless|
|
||||
|is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if channel is a supergroup and is not a broadcast|
|
||||
|is\_verified|[Bool](../types/Bool.md) | Yes|True, if the channel is verified|
|
||||
|restriction\_reason|[string](../types/string.md) | Yes|If non-empty, contains the reason, why access to this channel must be restricted. Format of the string is "{type}: {description}". {type} contains type of the restriction and at least one of the suffixes "-all", "-ios", "-android", "-wp", which describes platforms on which access should be restricted. For example, "terms-ios-android". {description} contains human-readable description of the restriction, which can be showed to the user|
|
||||
|
||||
|
||||
|
||||
### Type: [Channel](../types/Channel.md)
|
||||
|
||||
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
title: channelFull
|
||||
description: Gives full information about a channel
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelFull
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Gives full information about a channel
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|description|[string](../types/string.md) | Yes|Channel description|
|
||||
|member\_count|[int](../types/int.md) | Yes|Channel member count, 0 if unknown|
|
||||
|administrator\_count|[int](../types/int.md) | Yes|Number of privileged users in the channel, 0 if unknown|
|
||||
|restricted\_count|[int](../types/int.md) | Yes|Number of restricted users in the channel, 0 if unknown|
|
||||
|banned\_count|[int](../types/int.md) | Yes|Number of users banned from the channel, 0 if unknown|
|
||||
|can\_get\_members|[Bool](../types/Bool.md) | Yes|True, if members of the channel can be retrieved|
|
||||
|can\_set\_username|[Bool](../types/Bool.md) | Yes|True, if the channel can be made public|
|
||||
|can\_set\_sticker\_set|[Bool](../types/Bool.md) | Yes|True, if the channel sticker set can be changed|
|
||||
|sticker\_set\_id|[int64](../constructors/int64.md) | Yes|Identifier of channel sticker set, or 0 if none|
|
||||
|invite\_link|[string](../types/string.md) | Yes|Invite link for this channel|
|
||||
|pinned\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the pinned message in the channel chat, or 0 if none|
|
||||
|migrated\_from\_group\_id|[int](../types/int.md) | Yes|Identifier of the group, this supergroup migrated from, or 0 if none|
|
||||
|migrated\_from\_max\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last message in the group chat migrated from, or 0 if none|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelFull](../types/ChannelFull.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterAdministrators
|
||||
description: Return creator and administrators
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterAdministrators
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Return creator and administrators
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterBanned
|
||||
description: Return banned from the channel users, administrators only
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterBanned
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Return banned from the channel users, administrators only
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|query|[string](../types/string.md) | Yes|Query to search for|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterBots
|
||||
description: Return bot members of the channel
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterBots
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Return bot members of the channel
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterRecent
|
||||
description: Return recently active users in reverse chronological order
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterRecent
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Return recently active users in reverse chronological order
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterRestricted
|
||||
description: Return restricted channel members, administrators only
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterRestricted
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Return restricted channel members, administrators only
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|query|[string](../types/string.md) | Yes|Query to search for|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: channelMembersFilterSearch
|
||||
description: Searches for channel members using specified query
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMembersFilterSearch
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Searches for channel members using specified query
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|query|[string](../types/string.md) | Yes|Query to search for|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)
|
||||
|
||||
|
||||
@ -1,37 +0,0 @@
|
||||
---
|
||||
title: chat
|
||||
description: Chat (private chat or group chat or channel chat)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chat
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat (private chat or group chat or channel chat)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int53](../types/int53.md) | Yes|Chat unique identifier|
|
||||
|type|[ChatType](../types/ChatType.md) | Yes|Information about type of the chat|
|
||||
|title|[string](../types/string.md) | Yes|Chat title|
|
||||
|photo|[chatPhoto](../constructors/chatPhoto.md) | Yes|Chat photo, nullable|
|
||||
|top\_message|[message](../constructors/message.md) | Yes|Last message in the chat, nullable|
|
||||
|order|[int64](../constructors/int64.md) | Yes|Parameter by descending of which chats are sorted in the chat list. If order of two chats is equal, then they need to be sorted by id also in descending order. If order == 0, position of the chat in the list is undetermined|
|
||||
|is\_pinned|[Bool](../types/Bool.md) | Yes|True, if the chat is pinned|
|
||||
|unread\_count|[int](../types/int.md) | Yes|Count of unread messages in the chat|
|
||||
|last\_read\_inbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read incoming message|
|
||||
|last\_read\_outbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read outgoing message|
|
||||
|unread\_mention\_count|[int](../types/int.md) | Yes|Count of unread messages with mention/reply in the chat|
|
||||
|notification\_settings|[notificationSettings](../constructors/notificationSettings.md) | Yes|Notification settings for this chat|
|
||||
|reply\_markup\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which reply markup need to be used or 0 if there is no default custom reply markup in the chat|
|
||||
|draft\_message|[draftMessage](../constructors/draftMessage.md) | Yes|Draft of a message in the chat, nullable. parse_mode in input_message_text always will be null|
|
||||
|client\_data|[string](../types/string.md) | Yes|Client specified data, associated with the chat. For example, chat position or local chat notification settings may be stored here. Persistent if message db is used|
|
||||
|
||||
|
||||
|
||||
### Type: [Chat](../types/Chat.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionCancel
|
||||
description: User cancels previous action
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionCancel
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User cancels previous action
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionChoosingContact
|
||||
description: User chooses contact to send
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionChoosingContact
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User chooses contact to send
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionChoosingLocation
|
||||
description: User chooses location or venue to send
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionChoosingLocation
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User chooses location or venue to send
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionRecordingVideo
|
||||
description: User records a video
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionRecordingVideo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User records a video
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionRecordingVideoNote
|
||||
description: User records video note
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionRecordingVideoNote
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User records video note
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionRecordingVoice
|
||||
description: User records voice message
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionRecordingVoice
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User records voice message
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionStartPlayingGame
|
||||
description: User starts to play a game
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionStartPlayingGame
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User starts to play a game
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatActionTyping
|
||||
description: User typing a message
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionTyping
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User typing a message
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatActionUploadingDocument
|
||||
description: User uploads a document
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionUploadingDocument
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User uploads a document
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatActionUploadingPhoto
|
||||
description: User uploads a photo
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionUploadingPhoto
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User uploads a photo
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatActionUploadingVideo
|
||||
description: User uploads a video
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionUploadingVideo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User uploads a video
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatActionUploadingVideoNote
|
||||
description: User uploads a video note
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionUploadingVideoNote
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User uploads a video note
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatActionUploadingVoice
|
||||
description: User uploads voice message
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatActionUploadingVoice
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User uploads voice message
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatAction](../types/ChatAction.md)
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
---
|
||||
title: chatEvent
|
||||
description: Represents a chat event
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEvent
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents a chat event
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int64](../constructors/int64.md) | Yes|Chat event identifier|
|
||||
|date|[int](../types/int.md) | Yes|Date of the event, unix time|
|
||||
|user\_id|[int](../types/int.md) | Yes|Identifier of a user who made the action|
|
||||
|action|[ChatEventAction](../types/ChatEventAction.md) | Yes|Action done by the user|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEvent](../types/ChatEvent.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventDescriptionChanged
|
||||
description: Chat description was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventDescriptionChanged
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat description was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_description|[string](../types/string.md) | Yes|Old description value|
|
||||
|new\_description|[string](../types/string.md) | Yes|New description value|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatEventInvitesToggled
|
||||
description: Supergroup channel chat anyone_can_invite setting was toggled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventInvitesToggled
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Supergroup channel chat anyone_can_invite setting was toggled
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|anyone\_can\_invite|[Bool](../types/Bool.md) | Yes|New value of anyone_can_invite|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
title: chatEventLogFilters
|
||||
description: Represents a set of filters used to obtain a chat event log
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventLogFilters
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents a set of filters used to obtain a chat event log
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message\_edits|[Bool](../types/Bool.md) | Yes|True, if message edits should be returned|
|
||||
|message\_deletions|[Bool](../types/Bool.md) | Yes|True, if message deletions should be returned|
|
||||
|message\_pins|[Bool](../types/Bool.md) | Yes|True, if message pins should be returned|
|
||||
|member\_joins|[Bool](../types/Bool.md) | Yes|True, if chat member joins should be returned|
|
||||
|member\_leaves|[Bool](../types/Bool.md) | Yes|True, if chat member leaves should be returned|
|
||||
|member\_invites|[Bool](../types/Bool.md) | Yes|True, if chat member invites should be returned|
|
||||
|member\_promotions|[Bool](../types/Bool.md) | Yes|True, if chat member promotions/demotions should be returned|
|
||||
|member\_restrictions|[Bool](../types/Bool.md) | Yes|True, if chat member restrictions/unrestrictions including bans/unbans should be returned|
|
||||
|info\_changes|[Bool](../types/Bool.md) | Yes|True, if changes of chat information should be returned|
|
||||
|setting\_changes|[Bool](../types/Bool.md) | Yes|True, if changes of chat settings should be returned|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventLogFilters](../types/ChatEventLogFilters.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventMemberInvited
|
||||
description: New chat member invited
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMemberInvited
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
New chat member invited
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|New chat member user identifier|
|
||||
|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatEventMemberJoined
|
||||
description: New chat member joined
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMemberJoined
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
New chat member joined
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatEventMemberLeft
|
||||
description: A chat member left
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMemberLeft
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A chat member left
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: chatEventMemberPromoted
|
||||
description: A chat member promoted to/demoted from administrators
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMemberPromoted
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A chat member promoted to/demoted from administrators
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|Chat member user identifier|
|
||||
|old\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Old chat member status|
|
||||
|new\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: chatEventMemberRestricted
|
||||
description: A chat member restricted/unrestircted or banned/unbanned
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMemberRestricted
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A chat member restricted/unrestircted or banned/unbanned
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|Chat member user identifier|
|
||||
|old\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Old chat member status|
|
||||
|new\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatEventMessageDeleted
|
||||
description: A message was deleted
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMessageDeleted
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A message was deleted
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[message](../constructors/message.md) | Yes|Deleted message|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventMessageEdited
|
||||
description: A message was edited
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMessageEdited
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A message was edited
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_message|[message](../constructors/message.md) | Yes|Message before edit|
|
||||
|new\_message|[message](../constructors/message.md) | Yes|Message after edit|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatEventMessagePinned
|
||||
description: A message was pinned
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMessagePinned
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A message was pinned
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[message](../constructors/message.md) | Yes|Pinned message|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatEventMessageUnpinned
|
||||
description: A message was unpinned
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventMessageUnpinned
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
A message was unpinned
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventPhotoChanged
|
||||
description: Chat photo was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventPhotoChanged
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat photo was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_photo|[chatPhoto](../constructors/chatPhoto.md) | Yes|Old photo value, nullable|
|
||||
|new\_photo|[chatPhoto](../constructors/chatPhoto.md) | Yes|New photo value, nullable|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatEventSignMessagesToggled
|
||||
description: Broadcast channel chat sign_messages setting was toggled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventSignMessagesToggled
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Broadcast channel chat sign_messages setting was toggled
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|sign\_messages|[Bool](../types/Bool.md) | Yes|New value of sign_messages|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventStickerSetChanged
|
||||
description: Supergroup sticker set was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventStickerSetChanged
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Supergroup sticker set was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_sticker\_set\_id|[int64](../constructors/int64.md) | Yes|Old identifier of chat sticker set, 0 if none|
|
||||
|new\_sticker\_set\_id|[int64](../constructors/int64.md) | Yes|New identifier of chat sticker set, 0 if none|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventTitleChanged
|
||||
description: Chat title was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventTitleChanged
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat title was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_title|[string](../types/string.md) | Yes|Old title value|
|
||||
|new\_title|[string](../types/string.md) | Yes|New title value|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatEventUsernameChanged
|
||||
description: Chat username was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEventUsernameChanged
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat username was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|old\_username|[string](../types/string.md) | Yes|Old username value|
|
||||
|new\_username|[string](../types/string.md) | Yes|New username value|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEventAction](../types/ChatEventAction.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatEvents
|
||||
description: Contains list of chat events
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEvents
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains list of chat events
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|events|Array of [chatEvent](../constructors/chatEvent.md) | Yes|The events|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatEvents](../types/ChatEvents.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatInviteLink
|
||||
description: Contains chat invite link
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatInviteLink
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains chat invite link
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|invite\_link|[string](../types/string.md) | Yes|Chat invite link|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatInviteLink](../types/ChatInviteLink.md)
|
||||
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: chatInviteLinkInfo
|
||||
description: Contains information about chat invite link
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatInviteLinkInfo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains information about chat invite link
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the invite link or 0 if user is not a member of this chat|
|
||||
|title|[string](../types/string.md) | Yes|Title of the chat|
|
||||
|photo|[chatPhoto](../constructors/chatPhoto.md) | Yes|Chat photo, nullable|
|
||||
|member\_count|[int](../types/int.md) | Yes|Total member count|
|
||||
|member\_user\_ids|Array of [int](../types/int.md) | Yes|User identifiers of some chat members that may be known to the current user|
|
||||
|is\_group|[Bool](../types/Bool.md) | Yes|True, if the chat is a group chat|
|
||||
|is\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat|
|
||||
|is\_public\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat with set up username|
|
||||
|is\_supergroup\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a supergroup channel chat|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatInviteLinkInfo](../types/ChatInviteLinkInfo.md)
|
||||
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
---
|
||||
title: chatMember
|
||||
description: User with information about its chat joining/leaving
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMember
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User with information about its chat joining/leaving
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User identifier of the chat member|
|
||||
|inviter\_user\_id|[int](../types/int.md) | Yes|Identifier of a user invited/promoted/banned this member in the chat, 0 if unknown|
|
||||
|join\_date|[int](../types/int.md) | Yes|Date the user has joined a chat, unix time|
|
||||
|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Status of the member in the chat|
|
||||
|bot\_info|[botInfo](../constructors/botInfo.md) | Yes|Information about bot if user is a bot, nullable. Can be null even for bot if bot is not a chat member|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMember](../types/ChatMember.md)
|
||||
|
||||
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusAdministrator
|
||||
description: User is a chat member with some additional priviledges. In groups, administrators can edit and delete other messages, add new members and ban unpriviledged members
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusAdministrator
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is a chat member with some additional priviledges. In groups, administrators can edit and delete other messages, add new members and ban unpriviledged members
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_be\_edited|[Bool](../types/Bool.md) | Yes|True, if current user has rights to edit administrator privileges of that user|
|
||||
|can\_change\_info|[Bool](../types/Bool.md) | Yes|True, if the administrator can change chat title, photo and other settings|
|
||||
|can\_post\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can create channel posts, broadcast channels only|
|
||||
|can\_edit\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can edit messages of other users, broadcast channels only|
|
||||
|can\_delete\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can delete messages of other users|
|
||||
|can\_invite\_users|[Bool](../types/Bool.md) | Yes|True, if the administrator can invite new users to the chat|
|
||||
|can\_restrict\_members|[Bool](../types/Bool.md) | Yes|True, if the administrator can restrict, ban or unban chat members|
|
||||
|can\_pin\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can pin messages, supergroup channels only|
|
||||
|can\_promote\_members|[Bool](../types/Bool.md) | Yes|True, if the administrator can add new administrators with a subset of his own privileges or demote administrators directly or indirectly promoted by him|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusBanned
|
||||
description: User was banned (and obviously is not a chat member) and can't return to the chat or view messages
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusBanned
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User was banned (and obviously is not a chat member) and can't return to the chat or view messages
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|banned\_until\_date|[int](../types/int.md) | Yes|Date when the user will be unbanned, 0 if never. Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time it considered to be banned forever|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusCreator
|
||||
description: User is creator of the chat which has all administrator priviledges
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusCreator
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is creator of the chat which has all administrator priviledges
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusLeft
|
||||
description: User is not a chat member
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusLeft
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is not a chat member
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusMember
|
||||
description: User is a member of the chat, but have no any additional privileges or restrictions
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusMember
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User is a member of the chat, but have no any additional privileges or restrictions
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: chatMemberStatusRestricted
|
||||
description: User has some additional restrictions in the chat. Unsupported in group chats and broadcast channels
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMemberStatusRestricted
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
User has some additional restrictions in the chat. Unsupported in group chats and broadcast channels
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|is\_member|[Bool](../types/Bool.md) | Yes|True, if user is chat member|
|
||||
|restricted\_until\_date|[int](../types/int.md) | Yes|Date when the user will be unrestricted, 0 if never. Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time it considered to be restricted forever|
|
||||
|can\_send\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send text messages, contacts, locations and venues|
|
||||
|can\_send\_media\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages|
|
||||
|can\_send\_other\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages|
|
||||
|can\_add\_web\_page\_previews|[Bool](../types/Bool.md) | Yes|True, if user may add web page preview to his messages, implies can_send_messages|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMemberStatus](../types/ChatMemberStatus.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatMembers
|
||||
description: Contains list of chat members
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatMembers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains list of chat members
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|total\_count|[int](../types/int.md) | Yes|Approximate total count of found chat members|
|
||||
|members|Array of [chatMember](../constructors/chatMember.md) | Yes|List of members|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatMembers](../types/ChatMembers.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatPhoto
|
||||
description: Describes chat photo
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatPhoto
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Describes chat photo
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|small|[file](../constructors/file.md) | Yes|Small (160x160) chat photo|
|
||||
|big|[file](../constructors/file.md) | Yes|Big (640x640) chat photo|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatPhoto](../types/ChatPhoto.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatReportReasonOther
|
||||
description: Other reason provided by the user
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatReportReasonOther
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Other reason provided by the user
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|text|[string](../types/string.md) | Yes|Report text|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatReportReason](../types/ChatReportReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatReportReasonPornography
|
||||
description: The chat contains pornography messages
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatReportReasonPornography
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The chat contains pornography messages
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatReportReason](../types/ChatReportReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatReportReasonSpam
|
||||
description: The chat contains spam messages
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatReportReasonSpam
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The chat contains spam messages
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatReportReason](../types/ChatReportReason.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: chatReportReasonViolence
|
||||
description: The chat contains violent messages
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatReportReasonViolence
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The chat contains violent messages
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChatReportReason](../types/ChatReportReason.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatReportSpamState
|
||||
description: Contains information about chat report spam state
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatReportSpamState
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains information about chat report spam state
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_report\_spam|[Bool](../types/Bool.md) | Yes|If true, prompt with "Report spam" action should be shown to the user|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatReportSpamState](../types/ChatReportSpamState.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatTypeChannel
|
||||
description: Chat with unlimited number of members
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatTypeChannel
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat with unlimited number of members
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|channel\_id|[int](../types/int.md) | Yes|Channel identifier|
|
||||
|is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if the channel is a supergroup and is not a broadcast|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatType](../types/ChatType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatTypeGroup
|
||||
description: Chat with zero or more other users
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatTypeGroup
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Chat with zero or more other users
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|group\_id|[int](../types/int.md) | Yes|Group identifier|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatType](../types/ChatType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chatTypePrivate
|
||||
description: Ordinary chat with a user
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatTypePrivate
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Ordinary chat with a user
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User identifier|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatType](../types/ChatType.md)
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: chatTypeSecret
|
||||
description: Secret chat with a user
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatTypeSecret
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Secret chat with a user
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier|
|
||||
|user\_id|[int](../types/int.md) | Yes|User identifier of the peer|
|
||||
|
||||
|
||||
|
||||
### Type: [ChatType](../types/ChatType.md)
|
||||
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
title: chats
|
||||
description: Represents list of chats
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chats
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents list of chats
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|chat\_ids|Array of [int53](../types/int53.md) | Yes|List of chat identifiers|
|
||||
|
||||
|
||||
|
||||
### Type: [Chats](../types/Chats.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: connectionStateConnecting
|
||||
description: Establishing connection to Telegram servers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: connectionStateConnecting
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Establishing connection to Telegram servers
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ConnectionState](../types/ConnectionState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: connectionStateConnectingToProxy
|
||||
description: Establishing connection to set up proxy server
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: connectionStateConnectingToProxy
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Establishing connection to set up proxy server
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ConnectionState](../types/ConnectionState.md)
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: connectionStateReady
|
||||
description: There is a working connection to the Telegram servers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: connectionStateReady
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
There is a working connection to the Telegram servers
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ConnectionState](../types/ConnectionState.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user