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

Pages

Локальная пагинация списка. Создаёт данные и клавиатуру, но сама ничего не отправляет.

Получение объекта

pages = app.inline.pages(["first", "second"], size=1)

init

Создаёт Pages. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

def __init__(items: Iterable[JSON], size: int = 5, index: int = 0) -> None: ...

Аргументы

items: Iterable[JSON], обязательный. Элементы списка для локального постраничного просмотра.
size: int, по умолчанию 5. Положительное число элементов одной страницы.
index: int, по умолчанию 0. Позиция от нуля в указанном списке или строке. Допустимые границы проверяются методом.

Результат

None. Создаёт Pages. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

ValueError('A positive page size is required'): условие проверяется до продолжения операции.

Пример

# Обычный способ получения объекта:
pages = app.inline.pages(["first", "second"], size=1)

count

Возвращает число страниц, минимум 1 даже при пустом списке.

def count() -> int: ...

Свойство: читается без скобок и без await.

Аргументы

Нет.

Результат

int. Возвращает число страниц, минимум 1 даже при пустом списке.

Права

Ошибки

Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

value = pages.count

current

Возвращает срез элементов выбранной страницы.

def current() -> list[JSON]: ...

Свойство: читается без скобок и без await.

Аргументы

Нет.

Результат

list[JSON]. Возвращает срез элементов выбранной страницы.

Права

Ошибки

Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

value = pages.current

go

Выбирает существующую страницу по индексу от нуля.

def go(index: int) -> Self: ...

Аргументы

index: int, обязательный. Позиция от нуля в указанном списке или строке. Допустимые границы проверяются методом.

Результат

Self. Тот же объект после успешной операции. Выбирает существующую страницу по индексу от нуля.

Права

Ошибки

ValueError('Invalid page'): условие проверяется до продолжения операции.

Пример

result = pages.go(0)

Переходит к следующей странице, не выходя за последнюю.

def next() -> Self: ...

Аргументы

Нет.

Результат

Self. Тот же объект после успешной операции. Переходит к следующей странице, не выходя за последнюю.

Права

Ошибки

Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = pages.next()

Переходит к предыдущей странице, не выходя за первую.

def previous() -> Self: ...

Аргументы

Нет.

Результат

Self. Тот же объект после успешной операции. Переходит к предыдущей странице, не выходя за первую.

Права

Ошибки

Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = pages.previous()

Создаёт кнопки перехода и отключённый индикатор номера. Индекс целевой страницы передаётся в поле field обработчика.

def navigation(callback: str | Callable, values: JSON = None, field: str = 'page') -> Keyboard: ...

Аргументы

callback: str | Callable, обязательный. ID объявленного обработчика либо метод с соответствующим декоратором loader.
values: JSON, по умолчанию None. Данные выбранной операции. Форма и ограничения описаны ниже; передаваемые JSON-значения копируются.
field: str, по умолчанию 'page'. ID поля конфигурации либо имя аргумента пагинации.

Результат

Keyboard. Создаёт кнопки перехода и отключённый индикатор номера. Индекс целевой страницы передаётся в поле field обработчика.

Права

Ошибки

Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

result = pages.navigation("refresh")