openDAQ
Open data acquisition platform
Public Member Functions | List of all members
IUser Struct Referenceabstract

An immutable structure which describes an openDAQ user. It holds username, password as a hash string and a list of groups assigned to the user. More...

+ Inheritance diagram for IUser:
+ Collaboration diagram for IUser:

Detailed Description

An immutable structure which describes an openDAQ user. It holds username, password as a hash string and a list of groups assigned to the user.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getUsername (IString **username)=0
 Returns the username as a string. More...
 
virtual ErrCode INTERFACE_FUNC getGroups (IList **groups)=0
 Returns a list of group IDs which the user belongs to. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ getGroups()

virtual ErrCode INTERFACE_FUNC getGroups ( IList **  groups)
pure virtual

Returns a list of group IDs which the user belongs to.

Parameters
password[out]groups The list of group IDs which the user belongs to.

◆ getUsername()

virtual ErrCode INTERFACE_FUNC getUsername ( IString **  username)
pure virtual

Returns the username as a string.

Parameters
username[out]The username.