IosImportClientBrandingAttributes (AWS SDK for Java

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

All Implemented Interfaces:

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

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

IosImportClientBrandingAttributes()

Constructors
Constructor and Description
`IosImportClientBrandingAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IosImportClientBrandingAttributes`	`addLoginMessageEntry(String key, String value)` Add a single LoginMessage entry
`IosImportClientBrandingAttributes`	`clearLoginMessageEntries()` Removes all the entries added into LoginMessage.
`IosImportClientBrandingAttributes`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getForgotPasswordLink()` The forgotten password link.
`Map<String,String>`	`getLoginMessage()` The login message.
`ByteBuffer`	`getLogo()` The logo.
`ByteBuffer`	`getLogo2x()` The @2x version of the logo.
`ByteBuffer`	`getLogo3x()` The @3x version of 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`	`setLogo(ByteBuffer logo)` The logo.
`void`	`setLogo2x(ByteBuffer logo2x)` The @2x version of the logo.
`void`	`setLogo3x(ByteBuffer logo3x)` The @3x version of 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.
`IosImportClientBrandingAttributes`	`withForgotPasswordLink(String forgotPasswordLink)` The forgotten password link.
`IosImportClientBrandingAttributes`	`withLoginMessage(Map<String,String> loginMessage)` The login message.
`IosImportClientBrandingAttributes`	`withLogo(ByteBuffer logo)` The logo.
`IosImportClientBrandingAttributes`	`withLogo2x(ByteBuffer logo2x)` The @2x version of the logo.
`IosImportClientBrandingAttributes`	`withLogo3x(ByteBuffer logo3x)` The @3x version of the logo.
`IosImportClientBrandingAttributes`	`withSupportEmail(String supportEmail)` The support email.
`IosImportClientBrandingAttributes`	`withSupportLink(String supportLink)` The support link.

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

- Constructor Detail
  - IosImportClientBrandingAttributes
```
public IosImportClientBrandingAttributes()
```
- Method Detail
  - setLogo
```
public void setLogo(ByteBuffer logo)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo - 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.
  - getLogo
```
public ByteBuffer getLogo()
```
    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.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    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.
  - withLogo
```
public IosImportClientBrandingAttributes withLogo(ByteBuffer logo)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo - 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.
  - setLogo2x
```
public void setLogo2x(ByteBuffer logo2x)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo2x - The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or
  - getLogo2x
```
public ByteBuffer getLogo2x()
```
    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.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or
  - withLogo2x
```
public IosImportClientBrandingAttributes withLogo2x(ByteBuffer logo2x)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo2x - 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.
  - setLogo3x
```
public void setLogo3x(ByteBuffer logo3x)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo3x - The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or
  - getLogo3x
```
public ByteBuffer getLogo3x()
```
    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.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or
  - withLogo3x
```
public IosImportClientBrandingAttributes withLogo3x(ByteBuffer logo3x)
```
    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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    logo3x - 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 IosImportClientBrandingAttributes 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 IosImportClientBrandingAttributes 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 IosImportClientBrandingAttributes 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.
    
    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.
  - 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.
    
    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.
  - withLoginMessage
```
public IosImportClientBrandingAttributes 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLoginMessageEntry
```
public IosImportClientBrandingAttributes addLoginMessageEntry(String key,
                                                              String value)
```
    Add a single LoginMessage entry
    
    See Also:
    
    withLoginMessage(java.util.Map<java.lang.String, java.lang.String>)
  - clearLoginMessageEntries
```
public IosImportClientBrandingAttributes 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 IosImportClientBrandingAttributes 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 IosImportClientBrandingAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IosImportClientBrandingAttributes

Method Detail

setLogo

getLogo

withLogo

setLogo2x

getLogo2x

withLogo2x

setLogo3x

getLogo3x

withLogo3x

setSupportEmail

getSupportEmail

withSupportEmail

setSupportLink

getSupportLink

withSupportLink

setForgotPasswordLink

getForgotPasswordLink

withForgotPasswordLink

getLoginMessage

setLoginMessage

withLoginMessage

addLoginMessageEntry

clearLoginMessageEntries

toString

equals

hashCode

clone

marshall