Enginio Namespace

The Enginio namespace provides enums used throughout Enginio. More...

Header: #include <Enginio>


enum AuthenticationState { NotAuthenticated, Authenticating, Authenticated, AuthenticationFailure }
enum ErrorType { NoError, NetworkError, BackendError }
enum Operation { ObjectOperation, AccessControlOperation, FileOperation, UserOperation, UsergroupOperation, UsergroupMembersOperation }
enum Role { CreatedAtRole, UpdatedAtRole, IdRole, ObjectTypeRole, ..., JsonObjectRole }

Detailed Description

The Enginio namespace provides enums used throughout Enginio.

Type Documentation

enum Enginio::AuthenticationState

This enum describes the state of the user authentication.

Enginio::NotAuthenticated0No attempt to authenticate was made
Enginio::Authenticating1Authentication request has been sent to the server
Enginio::Authenticated2Authentication was successful
Enginio::AuthenticationFailure3Authentication failed

See also EnginioClient::authenticationState.

enum Enginio::ErrorType

Describes the type of error that occured when making a request to the Enginio backend.

Enginio::NoError0The reply returned without errors
Enginio::NetworkError1The error was a networking problem
Enginio::BackendError2The backend did not accept the query

enum Enginio::Operation

Enginio has a unified API for several operations. For example when using query(), the default is ObjectOperation, which means that the query will return objects from the database. When passing in UserOperation instead, the query will return users.

Enginio::ObjectOperation0Operate on objects
Enginio::AccessControlOperation1Operate on the ACL
Enginio::FileOperation5Operate with files
Enginio::UserOperation2Operate on users
Enginio::UsergroupOperation3Operate on groups
Enginio::UsergroupMembersOperation4Operate on group members

enum Enginio::Role

EnginioModel defines roles which represent data used by every object stored in the Enginio backend

Enginio::CreatedAtRole?When an item was created
Enginio::UpdatedAtRole?When an item was updated last time
Enginio::IdRole?What is the id of an item
Enginio::ObjectTypeRole?What is item type
Enginio::SyncedRoleQt::UserRole + 1Mark if an item is in sync with the backend
Enginio::CustomPropertyRoleQt::UserRole + 10The first role id that may be used for dynamically created roles.
Enginio::JsonObjectRole?Object like representation of an item

Additionally EnginioModel supports dynamic roles which are mapped directly from received data. EnginioModel is mapping an item's properties to role names.

Note: Some objects may not contain value for a static role, it may happen for example when an item is not in sync with the backend.

See also QAbstractItemModel::roleNames().

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.