MadelineProtoDocs/docs/Chat.md

51 lines
3.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: PWRTelegram chat
description: chat attributes, type and example
---
## Constructor: PWRTelegram chat
### Attributes:
| Name | Type | Required |Description|
|----------|---------------|----------|-----------|
|type|[string](API_docs/types/string.md) | Yes|bot, user, channel, supergroup or chat|
|id|[long](API_docs/types/long.md) | Yes|bot API chat id|
|access\_hash|[long](API_docs/types/long.md) | Optional|access hash of peer|
|first\_name|[string](API_docs/types/string.md) | Optional|First name of the user|
|last\_name|[string](API_docs/types/string.md) | Optional|Last name of the user|
|lang\_code|[string](API_docs/types/string.md) | Optional|Language of the user|
|username|[string](API_docs/types/string.md) | Optional|Username|
|verified|[Bool](API_docs/types/Bool.md) | Optional|Is the peer official?|
|restricted|[Bool](API_docs/types/Bool.md) | Optional|Is the peer restricted to the current user?|
|restriction\_reason|[string](API_docs/types/string.md) | Optional|Restriction reason|
|status|[UserStatus](API_docs/types/UserStatus.md) | Optional|Describes last time user was online|
|bot\_inline\_placeholder|[string](API_docs/types/string.md) | Optional|Inline placeholder of inline bot|
|bot\_nochats|[Bool](API_docs/types/Bool.md) | Optional|Can the bot be added to a group|
|about|[string](API_docs/types/string.md) | Optional|Description of supergroups/channels or bios of users|
|bot\_info|[BotInfo](API_docs/types/BotInfo.md) | Optional|Bot info of bots|
|phone\_calls\_available|[Bool](API_docs/types/Bool.md) | Optional|Are phone calls available for that user?|
|phone\_calls\_private|[Bool](API_docs/types/Bool.md) | Optional||
|common\_chats\_count|[int](API_docs/types/int.md) | Optional|Number of chats in common with that user|
|photo|[string](API_docs/types/string.md) | Optional|bot API file object the profile picture|
|title|[string](API_docs/types/string.md) | Optional|Chat title|
|participants\_count|[int](API_docs/types/int.md) | Optional|Number of participants in the chat.|
|kicked\_count|[int](API_docs/types/int.md) | Optional|Number of users kicked from the chat.|
|admin\_count|[int](API_docs/types/int.md) | Optional|Number of admins in the chat.|
|admin|[Bool](API_docs/types/Bool.md) | Optional|Are you an admin in this chat?|
|all\_members\_are\_administrators|[Bool](API_docs/types/Bool.md) | Optional|True if a group has All Members Are Admins enabled.|
|invite|[string](API_docs/types/string.md) | Optional|Invite link of the chat|
|participants|Array of [Participant](Participant.md) | Yes|Chat participants|
|democracy|[Bool](API_docs/types/Bool.md) | Optional|Can everyone add users to this chat?|
|signatures|[Bool](API_docs/types/Bool.md) | Optional|Are channel signatures enabled?|
|can\_view\_participants|[Bool](API_docs/types/Bool.md) | Optional|Can you view participants (you can still view the bots in channels even if this is false)|
|can\_set\_username|[Bool](API_docs/types/Bool.md) | Optional|Can you set the username of this channel/supergroup?|
|can\_set\_stickers|[Bool](API_docs/types/Bool.md) | Optional|Can you set the associated stickerpack of this channel/supergroup?|
|stickerset|[StickerSet](API_docs/types/StickerSet.md) | Optional|StickerSet associtaed to this channel/supergroup|
|migrated\_from\_chat\_id|[int](API_docs/types/int.md) | Optional|MTProto chat id of the original chat (render it negative to make it a bot API chat id)|
|migrated\_from\_max\_id|[int](API_docs/types/int.md) | Optional|Last message id before migration|
|pinned\_msg\_id|[int](API_docs/types/int.md) | Optional|Message id of pinned message|