IosClientBrandingAttributes (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspaces.model.IosClientBrandingAttributes

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IosClientBrandingAttributes
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.

Client branding attributes are public facing. Ensure you do not include sensitive information.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IosClientBrandingAttributes()

Constructors
Constructor and Description
`IosClientBrandingAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IosClientBrandingAttributes`	`addLoginMessageEntry(String key, String value)` Add a single LoginMessage entry
`IosClientBrandingAttributes`	`clearLoginMessageEntries()` Removes all the entries added into LoginMessage.
`IosClientBrandingAttributes`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getForgotPasswordLink()` The forgotten password link.
`Map<String,String>`	`getLoginMessage()` The login message.
`String`	`getLogo2xUrl()` The @2x version of the logo.
`String`	`getLogo3xUrl()` The @3x version of the logo.
`String`	`getLogoUrl()` The logo.
`String`	`getSupportEmail()` The support email.
`String`	`getSupportLink()` The support link.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setForgotPasswordLink(String forgotPasswordLink)` The forgotten password link.
`void`	`setLoginMessage(Map<String,String> loginMessage)` The login message.
`void`	`setLogo2xUrl(String logo2xUrl)` The @2x version of the logo.
`void`	`setLogo3xUrl(String logo3xUrl)` The @3x version of the logo.
`void`	`setLogoUrl(String logoUrl)` The logo.
`void`	`setSupportEmail(String supportEmail)` The support email.
`void`	`setSupportLink(String supportLink)` The support link.
`String`	`toString()` Returns a string representation of this object.
`IosClientBrandingAttributes`	`withForgotPasswordLink(String forgotPasswordLink)` The forgotten password link.
`IosClientBrandingAttributes`	`withLoginMessage(Map<String,String> loginMessage)` The login message.
`IosClientBrandingAttributes`	`withLogo2xUrl(String logo2xUrl)` The @2x version of the logo.
`IosClientBrandingAttributes`	`withLogo3xUrl(String logo3xUrl)` The @3x version of the logo.
`IosClientBrandingAttributes`	`withLogoUrl(String logoUrl)` The logo.
`IosClientBrandingAttributes`	`withSupportEmail(String supportEmail)` The support email.
`IosClientBrandingAttributes`	`withSupportLink(String supportLink)` The support link.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IosClientBrandingAttributes
```
public IosClientBrandingAttributes()
```
- Method Detail
  - setLogoUrl
```
public void setLogoUrl(String logoUrl)
```
    The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
    
    Parameters:
    
    logoUrl - The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
  - getLogoUrl
```
public String getLogoUrl()
```
    The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
    
    Returns:
    
    The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
  - withLogoUrl
```
public IosClientBrandingAttributes withLogoUrl(String logoUrl)
```
    The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
    
    Parameters:
    
    logoUrl - The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogo2xUrl
```
public void setLogo2xUrl(String logo2xUrl)
```
    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Parameters:
    
    logo2xUrl - The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or
  - getLogo2xUrl
```
public String getLogo2xUrl()
```
    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Returns:
    
    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or
  - withLogo2xUrl
```
public IosClientBrandingAttributes withLogo2xUrl(String logo2xUrl)
```
    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Parameters:
    
    logo2xUrl - The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogo3xUrl
```
public void setLogo3xUrl(String logo3xUrl)
```
    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Parameters:
    
    logo3xUrl - The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or
  - getLogo3xUrl
```
public String getLogo3xUrl()
```
    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Returns:
    
    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or
  - withLogo3xUrl
```
public IosClientBrandingAttributes withLogo3xUrl(String logo3xUrl)
```
    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
    
    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
    
    Parameters:
    
    logo3xUrl - The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportEmail
```
public void setSupportEmail(String supportEmail)
```
    The support email. The company's customer support email address.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
    Parameters:
    supportEmail - The support email. The company's customer support email address.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
  - getSupportEmail
```
public String getSupportEmail()
```
    The support email. The company's customer support email address.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
    Returns:
    The support email. The company's customer support email address.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
  - withSupportEmail
```
public IosClientBrandingAttributes withSupportEmail(String supportEmail)
```
    The support email. The company's customer support email address.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
    Parameters:
    supportEmail - The support email. The company's customer support email address.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default email is [email protected].
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportLink
```
public void setSupportLink(String supportLink)
```
    The support link. The link for the company's customer support page for their WorkSpace.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
    Parameters:
    supportLink - The support link. The link for the company's customer support page for their WorkSpace.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
  - getSupportLink
```
public String getSupportLink()
```
    The support link. The link for the company's customer support page for their WorkSpace.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
    Returns:
    The support link. The link for the company's customer support page for their WorkSpace.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
  - withSupportLink
```
public IosClientBrandingAttributes withSupportLink(String supportLink)
```
    The support link. The link for the company's customer support page for their WorkSpace.
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
    Parameters:
    supportLink - The support link. The link for the company's customer support page for their WorkSpace.
    
    In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    
    The default support link is [email protected].
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForgotPasswordLink
```
public void setForgotPasswordLink(String forgotPasswordLink)
```
    The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
    
    Parameters:
    
    forgotPasswordLink - The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
  - getForgotPasswordLink
```
public String getForgotPasswordLink()
```
    The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
    
    Returns:
    
    The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
  - withForgotPasswordLink
```
public IosClientBrandingAttributes withForgotPasswordLink(String forgotPasswordLink)
```
    The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
    
    Parameters:
    
    forgotPasswordLink - The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLoginMessage
```
public Map<String,String> getLoginMessage()
```
    The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
    
    Returns:
    
    The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
  - setLoginMessage
```
public void setLoginMessage(Map<String,String> loginMessage)
```
    The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
    
    Parameters:
    
    loginMessage - The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
  - withLoginMessage
```
public IosClientBrandingAttributes withLoginMessage(Map<String,String> loginMessage)
```
    The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
    
    Parameters:
    
    loginMessage - The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLoginMessageEntry
```
public IosClientBrandingAttributes addLoginMessageEntry(String key,
                                                        String value)
```
    Add a single LoginMessage entry
    
    See Also:
    
    withLoginMessage(java.util.Map<java.lang.String, java.lang.String>)
  - clearLoginMessageEntries
```
public IosClientBrandingAttributes clearLoginMessageEntries()
```
    Removes all the entries added into LoginMessage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IosClientBrandingAttributes clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class IosClientBrandingAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IosClientBrandingAttributes

Method Detail

setLogoUrl

getLogoUrl

withLogoUrl

setLogo2xUrl

getLogo2xUrl

withLogo2xUrl

setLogo3xUrl

getLogo3xUrl

withLogo3xUrl

setSupportEmail

getSupportEmail

withSupportEmail

setSupportLink

getSupportLink

withSupportLink

setForgotPasswordLink

getForgotPasswordLink

withForgotPasswordLink

getLoginMessage

setLoginMessage

withLoginMessage

addLoginMessageEntry

clearLoginMessageEntries

toString

equals

hashCode

clone

marshall