diff --git a/yandex_music/feed/event.py b/yandex_music/feed/event.py index 7b292c7..e141476 100644 --- a/yandex_music/feed/event.py +++ b/yandex_music/feed/event.py @@ -7,12 +7,42 @@ if TYPE_CHECKING: class Event(YandexMusicObject): - """Класс, представляющий . + """Класс, представляющий событие фида. + + Note: + Известные значения поля `type_`: `tracks`, `artists`, `albums`, `notification`. + + Поле `message` заполнено только когда `type` равен `notification`. + + Примером значения поля `type_for_from` может служить `recommended-similar-artists`. + + Наличие данных в `tracks`, `albums`, `artists` напрямую зависит от `type_`. Attributes: + id_ (:obj:`str`): Уникальный идентификатор события. + type_ (:obj:`str`): Тип события. + type_for_from (:obj:`str`): Откуда пришло событие. + title (:obj:`str`): Заголовок. + tracks (:obj:`list` из :obj:`yandex_music.Track`): Список треков. + artists (:obj:`list` из :obj:`yandex_music.ArtistEvent`): Список артистов с похожими и популярными треками. + albums (:obj:`list` из :obj:`yandex_music.AlbumEvent`): Список альбомов с треками. + message (:obj:`str`): Сообщение уведомления. + device (:obj:`str`): Устройство, с которого пришло уведомление. + tracks_count (:obj:`int`): Количество треков (возможно, уже не используется). client (:obj:`yandex_music.Client`): Клиент Yandex Music. Args: + id_ (:obj:`str`): Уникальный идентификатор события. + type_ (:obj:`str`): Тип события. + type_for_from (:obj:`str`, optional): Откуда пришло событие. + title (:obj:`str`, optional): Заголовок. + tracks (:obj:`list` из :obj:`yandex_music.Track`, optional): Список треков. + artists (:obj:`list` из :obj:`yandex_music.ArtistEvent`, optional): Список артистов с похожими и популярными + треками. + albums (:obj:`list` из :obj:`yandex_music.AlbumEvent`, optional): Список альбомов с треками. + message (:obj:`str`, optional): Сообщение уведомления. + device (:obj:`str`, optional): Устройство, с которого пришло уведомление. + tracks_count (:obj:`int`, optional): Количество треков (возможно, уже не используется). client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -54,7 +84,7 @@ class Event(YandexMusicObject): client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music. Returns: - :obj:`yandex_music.Event`: TODO. + :obj:`yandex_music.Event`: Событие фида. """ if not data: return None @@ -76,7 +106,7 @@ class Event(YandexMusicObject): client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music. Returns: - :obj:`list` из :obj:`yandex_music.Event`: TODO. + :obj:`list` из :obj:`yandex_music.Event`: События фида. """ if not data: return []