API Reference

This is the full reference of everything in pyryver.

Note

In all cases where a fully qualified name to something is used, such as pyryver.ryver.Ryver, any submodule can be ignored, as they are all imported into the global pyryver scope.

• Session
  • Ryver
    • Ryver.get_live_session()
    • Ryver.get_chat()
    • Ryver.get_user()
    • Ryver.get_forum()
    • Ryver.get_team()
    • Ryver.get_groupchat()
    • Ryver.get_object()
    • Ryver.get_info()
    • Ryver.get_notifs()
    • Ryver.mark_all_notifs_read()
    • Ryver.mark_all_notifs_seen()
    • Ryver.upload_file()
    • Ryver.create_link()
    • Ryver.invite_user()
    • Ryver.create_forum()
    • Ryver.create_team()
    • Ryver.load_chats()
    • Ryver.load_missing_chats()
    • Ryver.load_users()
    • Ryver.load_forums()
    • Ryver.load_teams()
    • Ryver.close()
• Live Session
  • RyverWS
    • RyverWS.on_chat()
    • RyverWS.on_chat_deleted()
    • RyverWS.on_chat_updated()
    • RyverWS.on_presence_changed()
    • RyverWS.on_user_typing()
    • RyverWS.on_connection_loss()
    • RyverWS.on_reconnect()
    • RyverWS.EVENT_REACTION_ADDED
    • RyverWS.EVENT_REACTION_REMOVED
    • RyverWS.EVENT_TOPIC_CHANGED
    • RyverWS.EVENT_TASK_CHANGED
    • RyverWS.EVENT_ENTITY_CHANGED
    • RyverWS.EVENT_ALL
    • RyverWS.on_event()
    • RyverWS.MSG_TYPE_CHAT
    • RyverWS.MSG_TYPE_CHAT_UPDATED
    • RyverWS.MSG_TYPE_CHAT_DELETED
    • RyverWS.MSG_TYPE_PRESENCE_CHANGED
    • RyverWS.MSG_TYPE_USER_TYPING
    • RyverWS.MSG_TYPE_EVENT
    • RyverWS.MSG_TYPE_ALL
    • RyverWS.on_msg_type()
    • RyverWS.send_chat()
    • RyverWS.typing()
    • RyverWS.send_typing()
    • RyverWS.send_clear_typing()
    • RyverWS.PRESENCE_AVAILABLE
    • RyverWS.PRESENCE_AWAY
    • RyverWS.PRESENCE_DO_NOT_DISTURB
    • RyverWS.PRESENCE_OFFLINE
    • RyverWS.send_presence_change()
    • RyverWS.is_connected()
    • RyverWS.set_auto_reconnect()
    • RyverWS.run_forever()
    • RyverWS.terminate()
    • RyverWS.start()
    • RyverWS.close()
  • RyverWSTyping
    • RyverWSTyping.start()
    • RyverWSTyping.stop()
  • WSConnectionError
  • ClosedError
  • ConnectionLossError
  • Callback Task Data Types
    • WSMessageData
    • WSChatMessageData
    • WSChatUpdatedData
    • WSChatDeletedData
    • WSPresenceChangedData
    • WSUserTypingData
    • WSEventData
• Ryver Entities
  • Object
    • Object.get_ryver()
    • Object.get_id()
    • Object.get_entity_type()
    • Object.get_raw_data()
    • Object.get_api_url()
    • Object.get_create_date()
    • Object.get_modify_date()
    • Object.get_app_link()
    • Object.get_creator()
    • Object.get_deferred_field()
    • Object.get_create_user()
    • Object.get_modify_user()
    • Object.get_type()
    • Object.is_instantiable()
    • Object.get_by_id()
  • Chats
    • Chat
      • Chat.get_jid()
      • Chat.get_name()
      • Chat.get_task_tags()
      • Chat.set_task_tags()
      • Chat.send_message()
      • Chat.get_topics()
      • Chat.get_messages()
      • Chat.get_message()
      • Chat.get_messages_surrounding()
      • Chat.get_task_board()
      • Chat.delete_task_board()
      • Chat.create_task_board()
      • Chat.delete_avatar()
      • Chat.set_avatar()
    • GroupChat
      • GroupChat.get_name()
      • GroupChat.get_nickname()
      • GroupChat.has_chat()
      • GroupChat.has_topics()
      • GroupChat.has_tasks()
      • GroupChat.does_announce_topics()
      • GroupChat.does_announce_tasks()
      • GroupChat.is_archived()
      • GroupChat.get_members()
      • GroupChat.get_member()
      • GroupChat.add_member()
      • GroupChat.remove_member()
      • GroupChat.create_topic()
      • GroupChat.change_settings()
      • GroupChat.set_archived()
      • GroupChat.delete()
      • GroupChat.join()
      • GroupChat.leave()
    • Forum
    • Team
  • Users
    • User
      • User.ROLE_USER
      • User.ROLE_ADMIN
      • User.ROLE_GUEST
      • User.USER_TYPE_MEMBER
      • User.USER_TYPE_GUEST
      • User.get_username()
      • User.get_display_name()
      • User.get_name()
      • User.get_role()
      • User.get_about()
      • User.get_time_zone()
      • User.get_email_address()
      • User.get_activated()
      • User.get_roles()
      • User.get_user_type()
      • User.is_admin()
      • User.accepted_invite()
      • User.set_profile()
      • User.set_activated()
      • User.set_org_role()
      • User.add_to_chat()
      • User.create_topic()
  • Group Chat Members
    • GroupChatMember
      • GroupChatMember.ROLE_MEMBER
      • GroupChatMember.ROLE_ADMIN
      • GroupChatMember.get_role()
      • GroupChatMember.as_user()
      • GroupChatMember.get_name()
      • GroupChatMember.is_admin()
      • GroupChatMember.remove()
      • GroupChatMember.set_role()
  • Messages (Including Topics)
    • Message
      • Message.get_body()
      • Message.get_author()
      • Message.react()
      • Message.unreact()
      • Message.get_reactions()
      • Message.get_reaction_counts()
      • Message.delete()
    • ChatMessage
      • ChatMessage.MSG_TYPE_PRIVATE
      • ChatMessage.MSG_TYPE_GROUPCHAT
      • ChatMessage.SUBTYPE_CHAT_MESSAGE
      • ChatMessage.SUBTYPE_TOPIC_ANNOUNCEMENT
      • ChatMessage.SUBTYPE_TASK_ANNOUNCEMENT
      • ChatMessage.get_msg_type()
      • ChatMessage.get_subtype()
      • ChatMessage.get_time()
      • ChatMessage.get_author_id()
      • ChatMessage.get_chat_type()
      • ChatMessage.get_chat_id()
      • ChatMessage.get_attached_file()
      • ChatMessage.get_announced_topic_id()
      • ChatMessage.get_announced_task_id()
      • ChatMessage.get_author()
      • ChatMessage.get_chat()
      • ChatMessage.react()
      • ChatMessage.unreact()
      • ChatMessage.delete()
      • ChatMessage.edit()
    • Topic
      • Topic.get_subject()
      • Topic.is_stickied()
      • Topic.is_archived()
      • Topic.archive()
      • Topic.unarchive()
      • Topic.reply()
      • Topic.get_replies()
      • Topic.edit()
    • TopicReply
      • TopicReply.get_topic()
  • Tasks
    • TaskBoard
      • TaskBoard.BOARD_TYPE_BOARD
      • TaskBoard.BOARD_TYPE_LIST
      • TaskBoard.get_name()
      • TaskBoard.get_board_type()
      • TaskBoard.get_prefix()
      • TaskBoard.get_categories()
      • TaskBoard.create_category()
      • TaskBoard.get_tasks()
      • TaskBoard.create_task()
      • TaskBoard.get_chat()
    • TaskCategory
      • TaskCategory.CATEGORY_TYPE_UNCATEGORIZED
      • TaskCategory.CATEGORY_TYPE_DONE
      • TaskCategory.CATEGORY_TYPE_OTHER
      • TaskCategory.get_name()
      • TaskCategory.get_position()
      • TaskCategory.get_category_type()
      • TaskCategory.get_task_board()
      • TaskCategory.edit()
      • TaskCategory.delete()
      • TaskCategory.archive()
      • TaskCategory.archive_tasks()
      • TaskCategory.move_position()
      • TaskCategory.move_tasks()
      • TaskCategory.get_tasks()
    • Task
      • Task.is_archived()
      • Task.get_subject()
      • Task.get_due_date()
      • Task.get_complete_date()
      • Task.is_completed()
      • Task.get_short_repr()
      • Task.get_position()
      • Task.get_comments_count()
      • Task.get_attachments_count()
      • Task.get_tags()
      • Task.get_task_board()
      • Task.get_task_category()
      • Task.get_assignees()
      • Task.set_complete_date()
      • Task.set_due_date()
      • Task.complete()
      • Task.uncomplete()
      • Task.archive()
      • Task.unarchive()
      • Task.move()
      • Task.get_checklist()
      • Task.get_parent()
      • Task.add_to_checklist()
      • Task.set_checklist()
      • Task.edit()
      • Task.get_comments()
      • Task.comment()
  • Files
    • Storage
      • Storage.STORAGE_TYPE_FILE
      • Storage.STORAGE_TYPE_LINK
      • Storage.get_storage_type()
      • Storage.get_name()
      • Storage.get_size()
      • Storage.get_content_id()
      • Storage.get_content_MIME_type()
      • Storage.get_file()
      • Storage.get_content_url()
      • Storage.delete()
      • Storage.make_avatar_of()
    • File
      • File.get_title()
      • File.get_name()
      • File.get_size()
      • File.get_url()
      • File.get_MIME_type()
      • File.request_data()
      • File.download_data()
      • File.delete()
  • Notifications
    • Notification
      • Notification.PREDICATE_MENTION
      • Notification.PREDICATE_GROUP_MENTION
      • Notification.PREDICATE_COMMENT
      • Notification.PREDICATE_TASK_COMPLETED
      • Notification.get_predicate()
      • Notification.get_subject_entity_type()
      • Notification.get_subject_id()
      • Notification.get_subjects()
      • Notification.get_object_entity_type()
      • Notification.get_object_id()
      • Notification.get_object()
      • Notification.get_via_entity_type()
      • Notification.get_via_id()
      • Notification.get_via()
      • Notification.get_new()
      • Notification.get_unread()
      • Notification.set_status()
  • Creators
    • Creator
      • Creator.name
      • Creator.avatar
      • Creator.to_dict()
• Utilities
  • Cache Data Storage
    • AbstractCacheStorage
      • AbstractCacheStorage.load()
      • AbstractCacheStorage.save()
    • FileCacheStorage
      • FileCacheStorage.load()
      • FileCacheStorage.save()
  • API Helpers
    • NO_CHANGE
    • get_type_from_entity()
    • retry_until_available()
    • iso8601_to_datetime()
    • datetime_to_iso8601()
    • get_obj_by_field()
  • Entity Types
    • TYPE_USER
    • TYPE_FORUM
    • TYPE_TEAM
    • TYPE_GROUPCHAT_MEMBER
    • TYPE_TOPIC
    • TYPE_TOPIC_REPLY
    • TYPE_NOTIFICATION
    • TYPE_STORAGE
    • TYPE_FILE
  • Common Field Names
    • FIELD_USERNAME
    • FIELD_EMAIL_ADDR
    • FIELD_DISPLAY_NAME
    • FIELD_NAME
    • FIELD_NICKNAME
    • FIELD_ID
    • FIELD_JID