All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::ILinkedAccount Struct Referenceabstract
Inheritance diagram for Glympse::ILinkedAccount:
Inheritance graph
[legend]

Public Member Functions

virtual GString getType ()=0
 Gets the type of the linked account. More...
 
virtual int32 getState ()=0
 Gets the state of the linked account which is an indication of the current state of the account in relation to the server, including transient states such as "linking", "unlinking" and "refreshing". More...
 
virtual int32 getStatus ()=0
 Gets the status of the linked account which is an indication of the last known state of the account metadata (i.e., tokens, secrets, etc.). More...
 
virtual GString getId ()=0
 Gets the ID of the linked account. More...
 
virtual GString getUserName ()=0
 Gets the username associated with the linked account. More...
 
virtual GString getDisplayName ()=0
 Gets the display name associated with the linked account. More...
 
virtual int32 getLogin ()=0
 Determines whether or not the type of the linked account is enabled for federated login. More...
 
virtual GServerError getError ()=0
 Gets detailed server error information. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Member Function Documentation

virtual GString Glympse::ILinkedAccount::getDisplayName ( )
pure virtual

Gets the display name associated with the linked account.

This is account-specific, but is typically either the name of the user, a login name or screen name.

Returns
The display name, or NULL if none exists.
virtual GServerError Glympse::ILinkedAccount::getError ( )
pure virtual

Gets detailed server error information.

This method returns NULL except in the context of LISTENER_LINKED_ACCOUNTS event propagation.

Returns
Error details, or NULL if no details are available or no error occurred.
virtual GString Glympse::ILinkedAccount::getId ( )
pure virtual

Gets the ID of the linked account.

This is account-specific, but is typically an opaque, unique identifier in the third-party service.

Returns
The acccount identifier.
virtual int32 Glympse::ILinkedAccount::getLogin ( )
pure virtual

Determines whether or not the type of the linked account is enabled for federated login.

Returns
The login state, which will be one of the GC::LINKED_ACCOUNT_LOGIN constants.
virtual int32 Glympse::ILinkedAccount::getState ( )
pure virtual

Gets the state of the linked account which is an indication of the current state of the account in relation to the server, including transient states such as "linking", "unlinking" and "refreshing".

Returns
The linking state, which will be one of the GC::LINKED_ACCOUNT_STATE constants.
virtual int32 Glympse::ILinkedAccount::getStatus ( )
pure virtual

Gets the status of the linked account which is an indication of the last known state of the account metadata (i.e., tokens, secrets, etc.).

Accounts that are in the "linked" state may have a status of "refresh needed", for example, or "ok".

Returns
The account status, which will be one of the GC::LINKED_ACCOUNT_STATUS constants.
virtual GString Glympse::ILinkedAccount::getType ( )
pure virtual

Gets the type of the linked account.

Returns
The account type, which will be one of the GC::LINKED_ACCOUNT_TYPE constants.
virtual GString Glympse::ILinkedAccount::getUserName ( )
pure virtual

Gets the username associated with the linked account.

This is account-specific, but is typically a unique identifier used for login, such as a login name or an email address.

Returns
The username.

The documentation for this struct was generated from the following file: