com.okta.sdk.impl.resource.brand

Class DefaultTheme

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<Theme>

com.okta.sdk.impl.resource.brand.DefaultTheme

All Implemented Interfaces:

Theme, ExtensibleResource, PropertyRetriever, Resource, Saveable<Theme>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultTheme
extends AbstractInstanceResource<Theme>
implements Theme

Theme

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultTheme(InternalDataStore dataStore)
DefaultTheme(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	deleteBrandThemeBackgroundImage(String brandId, String themeId) Deletes a Theme background image Deletes a Theme background image
void	deleteBrandThemeFavicon(String brandId, String themeId) Deletes a Theme favicon.
void	deleteBrandThemeLogo(String brandId, String themeId) Deletes a Theme logo.
String	getBackgroundImage()
EmailTemplateTouchPointVariant	getEmailTemplateTouchPointVariant()
EndUserDashboardTouchPointVariant	getEndUserDashboardTouchPointVariant()
ErrorPageTouchPointVariant	getErrorPageTouchPointVariant()
Map<String,Object>	getLinks()
String	getPrimaryColorContrastHex()
String	getPrimaryColorHex()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
String	getSecondaryColorContrastHex()
String	getSecondaryColorHex()
SignInPageTouchPointVariant	getSignInPageTouchPointVariant()
Theme	setEmailTemplateTouchPointVariant(EmailTemplateTouchPointVariant emailTemplateTouchPointVariant)
Theme	setEndUserDashboardTouchPointVariant(EndUserDashboardTouchPointVariant endUserDashboardTouchPointVariant)
Theme	setErrorPageTouchPointVariant(ErrorPageTouchPointVariant errorPageTouchPointVariant)
Theme	setPrimaryColorContrastHex(String primaryColorContrastHex)
Theme	setPrimaryColorHex(String primaryColorHex)
Theme	setSecondaryColorContrastHex(String secondaryColorContrastHex)
Theme	setSecondaryColorHex(String secondaryColorHex)
Theme	setSignInPageTouchPointVariant(SignInPageTouchPointVariant signInPageTouchPointVariant)
ThemeResponse	update(String brandId, String themeId, Theme theme) Update a theme for a brand Updates a theme for a brand
ImageUploadResponse	updateBrandThemeBackgroundImage(String brandId, String themeId, File file) Updates the background image for your Theme Updates the background image for your Theme
ImageUploadResponse	updateBrandThemeFavicon(String brandId, String themeId, File file) Updates the favicon for your theme Updates the favicon for your theme
ImageUploadResponse	uploadBrandThemeLogo(String brandId, String themeId, File file) Update a themes logo Updates the logo for your Theme

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

delete, save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultTheme

public DefaultTheme(InternalDataStore dataStore)

DefaultTheme

public DefaultTheme(InternalDataStore dataStore,
                    Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<Theme>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Theme

getBackgroundImage

public String getBackgroundImage()

Specified by:

getBackgroundImage in interface Theme

getEmailTemplateTouchPointVariant

public EmailTemplateTouchPointVariant getEmailTemplateTouchPointVariant()

Specified by:

getEmailTemplateTouchPointVariant in interface Theme

setEmailTemplateTouchPointVariant

public Theme setEmailTemplateTouchPointVariant(EmailTemplateTouchPointVariant emailTemplateTouchPointVariant)

Specified by:

setEmailTemplateTouchPointVariant in interface Theme

getEndUserDashboardTouchPointVariant

public EndUserDashboardTouchPointVariant getEndUserDashboardTouchPointVariant()

Specified by:

getEndUserDashboardTouchPointVariant in interface Theme

setEndUserDashboardTouchPointVariant

public Theme setEndUserDashboardTouchPointVariant(EndUserDashboardTouchPointVariant endUserDashboardTouchPointVariant)

Specified by:

setEndUserDashboardTouchPointVariant in interface Theme

getErrorPageTouchPointVariant

public ErrorPageTouchPointVariant getErrorPageTouchPointVariant()

Specified by:

getErrorPageTouchPointVariant in interface Theme

setErrorPageTouchPointVariant

public Theme setErrorPageTouchPointVariant(ErrorPageTouchPointVariant errorPageTouchPointVariant)

Specified by:

setErrorPageTouchPointVariant in interface Theme

getPrimaryColorContrastHex

public String getPrimaryColorContrastHex()

Specified by:

getPrimaryColorContrastHex in interface Theme

setPrimaryColorContrastHex

public Theme setPrimaryColorContrastHex(String primaryColorContrastHex)

Specified by:

setPrimaryColorContrastHex in interface Theme

getPrimaryColorHex

public String getPrimaryColorHex()

Specified by:

getPrimaryColorHex in interface Theme

setPrimaryColorHex

public Theme setPrimaryColorHex(String primaryColorHex)

Specified by:

setPrimaryColorHex in interface Theme

getSecondaryColorContrastHex

public String getSecondaryColorContrastHex()

Specified by:

getSecondaryColorContrastHex in interface Theme

setSecondaryColorContrastHex

public Theme setSecondaryColorContrastHex(String secondaryColorContrastHex)

Specified by:

setSecondaryColorContrastHex in interface Theme

getSecondaryColorHex

public String getSecondaryColorHex()

Specified by:

getSecondaryColorHex in interface Theme

setSecondaryColorHex

public Theme setSecondaryColorHex(String secondaryColorHex)

Specified by:

setSecondaryColorHex in interface Theme

getSignInPageTouchPointVariant

public SignInPageTouchPointVariant getSignInPageTouchPointVariant()

Specified by:

getSignInPageTouchPointVariant in interface Theme

setSignInPageTouchPointVariant

public Theme setSignInPageTouchPointVariant(SignInPageTouchPointVariant signInPageTouchPointVariant)

Specified by:

setSignInPageTouchPointVariant in interface Theme

deleteBrandThemeFavicon

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
public void deleteBrandThemeFavicon(String brandId,
                                                                                                                                                                                                                                              String themeId)

Deletes a Theme favicon. The org then uses the Okta default favicon. Deletes a Theme favicon. The org then uses the Okta default favicon.

Specified by:

deleteBrandThemeFavicon in interface Theme

Parameters:

brandId - (required)

themeId - (required)

deleteBrandThemeLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/logo")
public void deleteBrandThemeLogo(String brandId,
                                                                                                                                                                                                                                        String themeId)

Deletes a Theme logo. The org then uses the Okta default logo. Deletes a Theme logo. The org then uses the Okta default logo.

Specified by:

deleteBrandThemeLogo in interface Theme

Parameters:

brandId - (required)

themeId - (required)

deleteBrandThemeBackgroundImage

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
public void deleteBrandThemeBackgroundImage(String brandId,
                                                                                                                                                                                                                                                               String themeId)

Deletes a Theme background image Deletes a Theme background image

Specified by:

deleteBrandThemeBackgroundImage in interface Theme

Parameters:

brandId - (required)

themeId - (required)

updateBrandThemeFavicon

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
public ImageUploadResponse updateBrandThemeFavicon(String brandId,
                                                                                                                                                                                                                                                           String themeId,
                                                                                                                                                                                                                                                           File file)

Updates the favicon for your theme Updates the favicon for your theme

Specified by:

updateBrandThemeFavicon in interface Theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

uploadBrandThemeLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/logo")
public ImageUploadResponse uploadBrandThemeLogo(String brandId,
                                                                                                                                                                                                                                                     String themeId,
                                                                                                                                                                                                                                                     File file)

Update a themes logo Updates the logo for your Theme

Specified by:

uploadBrandThemeLogo in interface Theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

updateBrandThemeBackgroundImage

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
public ImageUploadResponse updateBrandThemeBackgroundImage(String brandId,
                                                                                                                                                                                                                                                                            String themeId,
                                                                                                                                                                                                                                                                            File file)

Updates the background image for your Theme Updates the background image for your Theme

Specified by:

updateBrandThemeBackgroundImage in interface Theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/brands/{brandId}/themes/{themeId}")
public ThemeResponse update(String brandId,
                                                                                                                                                                                                                           String themeId,
                                                                                                                                                                                                                           Theme theme)

Update a theme for a brand Updates a theme for a brand

Specified by:

update in interface Theme

Parameters:

brandId - (required)

themeId - (required)

theme - (required)

Returns:

ThemeResponse