User Tools

Site Tools


DzAuthenticationMgr

A class that manages authentication of a Daz 3D user account.

More...

Inherits :

Methods

Signals

voidbeginLogin ()
voidbeginLogout ()
voidcurrentAccountChanged ()
voidloggedIn ()
voidloggedOut ()

Detailed Description

This class does not provide access to any Daz 3D user account information which could be considered an invasion of the user's the privacy. This class does provide plugins and scripts with an ability to check if a user has authenticated (logged in to) a Daz 3D account, to prompt a user to authenticate (login to) their Daz 3D account, to obtain a token that uniquely and anonymously identifies the current/last account authenticated, and to logout of an account that is currently logged in.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Do not create an instance of this class, rather request the instance from DzApp via DzApp::getAuthenticationMgr().

See Also:

Methods


Boolean : authenticateUser()

This function will attempt to authenticate a Daz 3D user account. If no account information has been entered by the user, a dialog will be displayed to securely acquire the username and password to be authenticated.

Return Value:

  • true if the user was authenticated, otherwise false.

String : getUserToken()

Return Value:

  • If the user has (not necessarily is) logged in to a Daz 3D user account and the application has a valid connection to the database, a token that represents the account that the user last logged into is returned. If the user has not logged into a Daz 3D user account or the application does not have a valid connection to the database, an empty string is returned.

Attention:

  • This function existed prior to 4.9.3.66 but it was deprecated as part of a much older implementation and it would only return an empty string. As of 4.9.3.66 the function has been revived and the function operates as described above.

See Also:


Boolean : isAuthenticated()

Return Value:

  • true if the user is authenticated (currently logged in), otherwise false.

Boolean : isLoggingIn()

Return Value:

  • true if in process of logging in, otherwise false. The event queue must execute to finish login.

Since:

  • 4.9.3.71

void : logout()

Invalidates any existing authentication.

Signals


void : beginLogin()

Signature:“beginLogin()”

Emitted when the user begins to login to a Daz 3D account.


void : beginLogout()

Signature:“beginLogout()”

Emitted when the user begins to log out of a Daz 3D account.


void : currentAccountChanged()

Signature:“currentAccountChanged()”

Emitted when the current Daz 3D account in use changes.


void : loggedIn()

Signature:“loggedIn()”

Emitted after the user has successfully logged in to a Daz 3D account.


void : loggedOut()

Signature:“loggedOut()”

Emitted after the user has successfully logged out of a Daz 3D account.