Package ru.yoricya.tgsaver

Class PluginAPI.Event

java.lang.Object
ru.yoricya.tgsaver.PluginAPI.Event
Enclosing class:
PluginAPI
public static class PluginAPI.Event extends Object
Класс для создания событий

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTIVE_STATE
    Тип события при изменении этапа загрузки ТГСейвера: Активен
    static final int
    ALL_EVENTS
    Тип события при срабатывании любого события
    static final int
    CLOSED_STATE
    Тип события при изменении этапа загрузки ТГСейвера: Закрыта сессия
    static final int
    CLOSING_STATE
    Тип события при изменении этапа загрузки ТГСейвера: Закрывается сессия
    final @Nullable PluginAPI.EventData
    EventData
    Данные из события (необходимо применять cast в зависимости от типа события, чтобы извлечь данные события) (МОЖЕТ БЫТЬ NULL!)
    final int
    EventType
    Тип события
    static final int
    MESSAGE_CONTENT_EDITED
    Тип события при получении изменённого сообщения
    static final int
    MESSAGE_FILE_EVENT
    Тип события при получении сообщения в виде файла
    static final int
    MESSAGE_OTHER_EVENT
    Тип события при получении неизвестного типа сообщения
    static final int
    MESSAGE_PHOTO_EVENT
    Тип события при получении фото-сообщения
    static final int
    MESSAGE_TEXT_EVENT
    Тип события при получении текстового сообщения
    static final int
    MESSAGE_VIDEO_EVENT
    Тип события при получении видео-сообщения
    static final int
    MESSAGE_VIDEONOTE_EVENT
    Тип события при получении сообщения - видео в формате кружочка
    static final int
    ON_CHAT_SAVE
    Тип события при сохранении чатов
    static final int
    ON_CHAT_SAVED
    Тип события после сохранения чатов
    static final int
    ON_ERROR_OTHER
    Тип события при возникновении неизвестной ошибки
    static final int
    ON_FILE_DOWNLOAD_SUCCESS
    Тип события после сохранения файла
    static final int
    ON_FILE_DOWNLOADING
    Тип события при сохранении файла
    static final int
    ON_FILE_SAVED
    Тип события после сохранения файла
    static final int
    ON_MENTION_READ
    Тип события при прочтении вашего сообщения собеседником (пока-что не используется)
    static final int
    ON_OUT_OF_DISK_SPACE_ERROR
    Тип события при возникновении неизвестной ошибки
    static final int
    ON_PLUGIN_LOAD_ERROR
    Тип события при ошибке загрузки плагина
    static final int
    ON_PLUGIN_LOADED
    Тип события после загрузки плагина
    static final int
    ON_PLUGINS_LOADED
    Тип события после загрузки всех плагинов
    static final int
    ON_TELEGRAMERROR_OTHER
    Тип события при возникновении неизвестной ошибки телеграма
    static final int
    ON_TELEGRAMERROR_PHONENUMBER
    Тип события при возникновении ошибки связанной с телефоном пользователя
    static final int
    UNLOGGED_STATE
    Тип события при изменении этапа загрузки ТГСейвера: Пользователь разлогинен
    @Nullable Object
    UserData
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelEvent(ru.yoricya.tgsaver.PluginLoader.Plugin plugin)
    Отмена события.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ALL_EVENTS

      public static final int ALL_EVENTS
      Тип события при срабатывании любого события
      See Also:

    • MESSAGE_OTHER_EVENT

      public static final int MESSAGE_OTHER_EVENT
      Тип события при получении неизвестного типа сообщения
      See Also:

    • MESSAGE_TEXT_EVENT

      public static final int MESSAGE_TEXT_EVENT
      Тип события при получении текстового сообщения
      See Also:

    • MESSAGE_PHOTO_EVENT

      public static final int MESSAGE_PHOTO_EVENT
      Тип события при получении фото-сообщения
      See Also:

    • MESSAGE_VIDEO_EVENT

      public static final int MESSAGE_VIDEO_EVENT
      Тип события при получении видео-сообщения
      See Also:

    • MESSAGE_VIDEONOTE_EVENT

      public static final int MESSAGE_VIDEONOTE_EVENT
      Тип события при получении сообщения - видео в формате кружочка
      See Also:

    • MESSAGE_FILE_EVENT

      public static final int MESSAGE_FILE_EVENT
      Тип события при получении сообщения в виде файла
      See Also:

    • MESSAGE_CONTENT_EDITED

      public static final int MESSAGE_CONTENT_EDITED
      Тип события при получении изменённого сообщения
      See Also:

    • ACTIVE_STATE

      public static final int ACTIVE_STATE
      Тип события при изменении этапа загрузки ТГСейвера: Активен
      See Also:

    • CLOSING_STATE

      public static final int CLOSING_STATE
      Тип события при изменении этапа загрузки ТГСейвера: Закрывается сессия
      See Also:

    • CLOSED_STATE

      public static final int CLOSED_STATE
      Тип события при изменении этапа загрузки ТГСейвера: Закрыта сессия
      See Also:

    • UNLOGGED_STATE

      public static final int UNLOGGED_STATE
      Тип события при изменении этапа загрузки ТГСейвера: Пользователь разлогинен
      See Also:

    • ON_CHAT_SAVE

      public static final int ON_CHAT_SAVE
      Тип события при сохранении чатов
      See Also:

    • ON_CHAT_SAVED

      public static final int ON_CHAT_SAVED
      Тип события после сохранения чатов
      See Also:

    • ON_TELEGRAMERROR_PHONENUMBER

      public static final int ON_TELEGRAMERROR_PHONENUMBER
      Тип события при возникновении ошибки связанной с телефоном пользователя
      See Also:

    • ON_TELEGRAMERROR_OTHER

      public static final int ON_TELEGRAMERROR_OTHER
      Тип события при возникновении неизвестной ошибки телеграма
      See Also:

    • ON_OUT_OF_DISK_SPACE_ERROR

      public static final int ON_OUT_OF_DISK_SPACE_ERROR
      Тип события при возникновении неизвестной ошибки
      Since:
      Beta 2.0.Beta 2.0-Beta-6
      See Also:

    • ON_ERROR_OTHER

      public static final int ON_ERROR_OTHER
      Тип события при возникновении неизвестной ошибки
      See Also:

    • ON_FILE_DOWNLOADING

      public static final int ON_FILE_DOWNLOADING
      Тип события при сохранении файла
      See Also:

    • ON_FILE_DOWNLOAD_SUCCESS

      public static final int ON_FILE_DOWNLOAD_SUCCESS
      Тип события после сохранения файла
      See Also:

    • ON_FILE_SAVED

      public static final int ON_FILE_SAVED
      Тип события после сохранения файла
      Since:
      Beta 2.0.Beta 2.0-Beta-6
      See Also:

    • ON_PLUGIN_LOADED

      public static final int ON_PLUGIN_LOADED
      Тип события после загрузки плагина
      Since:
      Beta 2.0.14Sep_23
      See Also:

    • ON_PLUGINS_LOADED

      public static final int ON_PLUGINS_LOADED
      Тип события после загрузки всех плагинов
      Since:
      Beta 2.0.14Sep_23
      See Also:

    • ON_PLUGIN_LOAD_ERROR

      public static final int ON_PLUGIN_LOAD_ERROR
      Тип события при ошибке загрузки плагина
      Since:
      Beta 2.0.14Sep_23
      See Also:

    • ON_MENTION_READ

      public static final int ON_MENTION_READ
      Тип события при прочтении вашего сообщения собеседником (пока-что не используется)
      Since:
      Beta 2.0.Beta-8
      See Also:

    • EventType

      public final int EventType
      Тип события

    • EventData

      @Nullable public final @Nullable PluginAPI.EventData EventData
      Данные из события (необходимо применять cast в зависимости от типа события, чтобы извлечь данные события) (МОЖЕТ БЫТЬ NULL!)

    • UserData

      @Nullable @Deprecated(forRemoval=true) public @Nullable Object UserData
      Deprecated, for removal: This API element is subject to removal in a future version.
      Данные о пользователе (необходимо применять cast в зависимости от типа события, чтобы извлечь данные события) (МОЖЕТ БЫТЬ NULL!)

  • Method Details

    • cancelEvent

      public void cancelEvent(ru.yoricya.tgsaver.PluginLoader.Plugin plugin)
      Отмена события. Примечание: Работает только если приоритет слушателя - OWNED!
      Parameters:
      plugin - Экземпляр вашего плагина.
      Since:
      Beta 2.0.Beta-8