Package com.atlassian.servicedesk.api.portal.login

Class PortalLoginPageDataContext

java.lang.Object

com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext

@Internal
public class PortalLoginPageDataContext
extends Object

An object that represents the data context useful to display the login page in the customer portal.

Constructor Summary

Constructors

Constructor	Description
PortalLoginPageDataContext(String signUpPageUrl, String passwordResetPageUrl, String logoUrl, String bannerImageUrl, String bannerBackgroundColor, String buttonBackgroundColor, String buttonTextColor, String portalLoginAnnouncementSubject, String portalLoginAnnouncementMessage)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getBannerBackgroundColor()	Returns the banner background colour hexadecimal code.
Optional<String>	getBannerImageUrl()	Returns the banner background image relative URL.
Optional<String>	getButtonBackgroundColor()	Returns the button background colour hexadecimal code.
Optional<String>	getButtonTextColor()	Returns the button text colour hexadecimal code.
Optional<String>	getLogoUrl()	Returns the global logo image relative URL.
Optional<String>	getPasswordResetPageUrl()	Returns the relative URL to the forgot password page when supported.
Optional<String>	getPortalLoginAnnouncementMessage()	Returns the portal login announcement message enriched with HTML.
Optional<String>	getPortalLoginAnnouncementSubject()	Returns the portal login announcement subject enriched with HTML.
Optional<String>	getSignUpPageUrl()	Returns the relative URL to the sign up page when sign up is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PortalLoginPageDataContext

public PortalLoginPageDataContext(@Nullable
 String signUpPageUrl,
 @Nullable
 String passwordResetPageUrl,
 @Nullable
 String logoUrl,
 @Nullable
 String bannerImageUrl,
 @Nullable
 String bannerBackgroundColor,
 @Nullable
 String buttonBackgroundColor,
 @Nullable
 String buttonTextColor,
 @Nullable
 String portalLoginAnnouncementSubject,
 @Nullable
 String portalLoginAnnouncementMessage)

Method Details

getSignUpPageUrl

public Optional<String> getSignUpPageUrl()

Returns the relative URL to the sign up page when sign up is enabled. The URL will be tailored for the specific portal or for the global help center otherwise depending on the URL path context provided.

Returns:

An optional containing the relative URL to the sign up page when sign up is enabled.

getPasswordResetPageUrl

public Optional<String> getPasswordResetPageUrl()

Returns the relative URL to the forgot password page when supported. The URL will be tailored for the specific portal or for the global help center otherwise depending on the URL path context provided.

Returns:

An optional containing the relative URL to the forgot password page when supported.

getLogoUrl

public Optional<String> getLogoUrl()

Returns the global logo image relative URL.

Returns:

An optional containing the relative URL of the global logo image.

getBannerImageUrl

public Optional<String> getBannerImageUrl()

Returns the banner background image relative URL.

Returns:

An optional containing the relative URL of the banner background image.

getBannerBackgroundColor

public Optional<String> getBannerBackgroundColor()

Returns the banner background colour hexadecimal code.

Returns:

An optional containing the hexadecimal code of the banner background colour.

getButtonBackgroundColor

public Optional<String> getButtonBackgroundColor()

Returns the button background colour hexadecimal code.

Returns:

An optional containing the hexadecimal code of the button background colour.

getButtonTextColor

public Optional<String> getButtonTextColor()

Returns the button text colour hexadecimal code.

Returns:

An optional containing the hexadecimal code of the button text colour.

getPortalLoginAnnouncementSubject

public Optional<String> getPortalLoginAnnouncementSubject()

Returns the portal login announcement subject enriched with HTML. The subject will be returned translated if a locale is passed on to the HTTP header (AcceptLanguage) and a translation exists for the subject.

Returns:

An optional containing the portal login announcement subject.

getPortalLoginAnnouncementMessage

public Optional<String> getPortalLoginAnnouncementMessage()

Returns the portal login announcement message enriched with HTML. The message will be returned translated if a locale is passed on to the HTTP header (AcceptLanguage) and a translation exists for the message.

Returns:

An optional containing the portal login announcement message.