SignOn::UiSessionData Class

Data container to hold values for the user interaction of an authentication session. More...

• Header: #include <SignOn/UiSessionData>
• Inherits: SignOn::SessionData

List of all members, including inherited members

#Public Functions

• UiSessionData(const QVariantMap &data = QVariantMap())
• void setCaptchaImage(const QByteArray &value)
• QByteArray CaptchaImage() const
• void setCaptchaResponse(const QString &value)
• QString CaptchaResponse() const
• void setCaptchaUrl(const QString &value)
• QString CaptchaUrl() const
• void setCaption(const QString &value)
• QString Caption() const
• void setConfirm(const bool &value)
• bool Confirm() const
• void setFinalUrl(const QString &value)
• QString FinalUrl() const
• void setForgotPassword(const QString &value)
• QString ForgotPassword() const
• void setForgotPasswordUrl(const QString &value)
• QString ForgotPasswordUrl() const
• void setIcon(const QString &value)
• QString Icon() const
• void setOpenUrl(const QString &value)
• QString OpenUrl() const
• void setQueryErrorCode(const int &value)
• int QueryErrorCode() const
• void setQueryMessage(const QString &value)
• QString QueryMessage() const
• void setQueryMessageId(const int &value)
• int QueryMessageId() const
• void setQueryPassword(const bool &value)
• bool QueryPassword() const
• void setQueryUserName(const bool &value)
• bool QueryUserName() const
• void setRememberPassword(const bool &value)
• bool RememberPassword() const
• void setShowRealm(const bool &value)
• bool ShowRealm() const
• void setTitle(const QString &value)
• QString Title() const
• void setUrlResponse(const QString &value)
• QString UrlResponse() const

#Detailed Description

Inherit this class if you want to extend the property range.

Warning: All this class' definitions must be inline.

#Member Function Documentation

#UiSessionData::UiSessionData(const QVariantMap &data = QVariantMap())

Constructor. Creates a UiSessionData containing data.

Note: Internal use only recommended. As a SSO client application developer use setters/getters for specific SessionData properties.

#void UiSessionData::setCaptchaImage(const QByteArray &value)

#QByteArray UiSessionData::CaptchaImage() const

The property CaptchaImage contains the captcha image to be verified by user. CaptchaImage is passed to signon-ui when plugin requires the captcha verification from user. If this is empty, captcha query is not shown, unless CaptchaUrl point to valid image.

#void UiSessionData::setCaptchaResponse(const QString &value)

#QString UiSessionData::CaptchaResponse() const

The property CaptchaResponse is passed to plugin after signon-ui has processed the captcha query. It contains user input for captcha query.

See also CaptchaUrl(), CaptchaImage()

#void UiSessionData::setCaptchaUrl(const QString &value)

#QString UiSessionData::CaptchaUrl() const

The property CaptchaUrl contains url to the captcha image to be verified by user. CaptchaUrl is used in signon-ui when plugin requires the captcha verification from user. If this is empty, captcha query is not shown, unless CaptchaImage contain valid image.

#void UiSessionData::setCaption(const QString &value)

#QString UiSessionData::Caption() const

The property Caption is used to set credentials caption. Empty caption is discarded.

Warning: This string is shown to user as it is, plugin is responsible for localization.

#void UiSessionData::setConfirm(const bool &value)

#bool UiSessionData::Confirm() const

The property Confirm will set dialog to confirm password mode.

#void UiSessionData::setFinalUrl(const QString &value)

#QString UiSessionData::FinalUrl() const

The property FinalUrl: if this URL is set, the signon-ui browser widget will close automatically when this URL is reached.

#void UiSessionData::setForgotPassword(const QString &value)

#QString UiSessionData::ForgotPassword() const

The property ForgotPassword: this string is shown as a link to user.

See also ForgotPasswordUrl()

#void UiSessionData::setForgotPasswordUrl(const QString &value)

#QString UiSessionData::ForgotPasswordUrl() const

The property ForgotPasswordUrl is shown to user if ForgotPassword link is pressed.

See also ForgotPassword()

#void UiSessionData::setIcon(const QString &value)

#QString UiSessionData::Icon() const

The property Icon is shown to user in signin dialog.

#void UiSessionData::setOpenUrl(const QString &value)

#QString UiSessionData::OpenUrl() const

The property OpenUrl: this url is passed to signon-ui to be opened and shown to user. Empty url does not open the url view.

#void UiSessionData::setQueryErrorCode(const int &value)

#int UiSessionData::QueryErrorCode() const

The property QueryErrorCode is used to report errors in ui interaction that is shown to user.

See also SignOn::QueryError

#void UiSessionData::setQueryMessage(const QString &value)

#QString UiSessionData::QueryMessage() const

The property QueryMessage is used to show given message to user. Empty message is discarded.

Warning: This string is shown to user as it is, plugin is responsible for localization.

#void UiSessionData::setQueryMessageId(const int &value)

#int UiSessionData::QueryMessageId() const

The property QueryMessageId is used to select predefined localized message that is shown to user.

See also SignOn::QueryMessageId

#void UiSessionData::setQueryPassword(const bool &value)

#bool UiSessionData::QueryPassword() const

The property QueryPassword is used to enable password input in signon-ui.

#void UiSessionData::setQueryUserName(const bool &value)

#bool UiSessionData::QueryUserName() const

The property QueryUserName is used to enable username input in signon-ui.

#void UiSessionData::setRememberPassword(const bool &value)

#bool UiSessionData::RememberPassword() const

The property RememberPassword is used to enable password storing signond.

#void UiSessionData::setShowRealm(const bool &value)

#bool UiSessionData::ShowRealm() const

The property ShowRealm is used to show realm in signon-ui.

#void UiSessionData::setTitle(const QString &value)

#QString UiSessionData::Title() const

The property Title is used to set dialog title for password confirmation.

Warning: This string is shown to user as it is.

#void UiSessionData::setUrlResponse(const QString &value)

#QString UiSessionData::UrlResponse() const

The property UrlResponse: the response from signon-ui for OpenUrl request. After completion UrlResponse contains redirect target url, if there was redirection.

#Related Non-Members

#enum QueryError

Error codes for ui interaction.

#enum QueryMessageId

Predefined messages to be shown to user while querying input.