Cluster · разработчикам

TL communities · методы

Каталог и общие правила · Справочник SDK

communities.Create

Аргументы

• about: Optional[str], необязательный; значение None.
• hidden: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• title: str, обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.Create(peer=peer, title=title)

Описание Telegram

communities.GetJoinedCommunities

Аргументы

Нет.

Результат

messages.Chats, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.GetJoinedCommunities()

Описание Telegram

communities.GetParticipantJoinedChats

Аргументы

• community: 'TypeInputChannel', обязательный.
• participant: 'TypeInputPeer', обязательный.

Результат

communities.ParticipantJoinedChats, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.GetParticipantJoinedChats(community=community, participant=participant)

Описание Telegram

communities.GetPeerLinkRequests

Аргументы

• community: 'TypeInputChannel', обязательный.
• limit: int, обязательный.
• offset: str, обязательный.

Результат

communities.PeerLinkRequests, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.GetPeerLinkRequests(community=community, limit=limit, offset=offset)

Описание Telegram

communities.TL

Аргументы

Нет.

Результат

Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.TL()

Описание Telegram

communities.ToggleAllPeerLinkRequestApproval

Аргументы

• community: 'TypeInputChannel', обязательный.
• reject: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.ToggleAllPeerLinkRequestApproval(community=community)

Описание Telegram

communities.ToggleCommunityCollapsedInDialogs

Аргументы

• collapsed: Optional[bool], необязательный; значение None.
• community: 'TypeInputChannel', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.ToggleCommunityCollapsedInDialogs(community=community)

Описание Telegram

communities.ToggleParticipantBanned

Аргументы

• community: 'TypeInputChannel', обязательный.
• participant: 'TypeInputPeer', обязательный.
• unban: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.ToggleParticipantBanned(community=community, participant=participant)

Описание Telegram

communities.TogglePeerLink

Аргументы

• community: 'TypeInputChannel', обязательный.
• deleted: Optional[bool], необязательный; значение None.
• hidden: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• visible: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.TogglePeerLink(community=community, peer=peer)

Описание Telegram

communities.TogglePeerLinkRequestApproval

Аргументы

• community: 'TypeInputChannel', обязательный.
• peer: 'TypeInputPeer', обязательный.
• reject: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.communities.TogglePeerLinkRequestApproval(community=community, peer=peer)

Описание Telegram