ModalViewPayload (slack-base 1.12 API)

java.lang.Object
- com.hubspot.slack.client.models.views.ModalViewPayload

All Implemented Interfaces:

ModalViewPayloadBase, ModalViewPayloadIF, ViewPayloadBase, ViewPayloadJsonBase
```
@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","ModalViewPayloadIF"})
 @Immutable
public final class ModalViewPayload
extends Object
implements ModalViewPayloadIF
```
Immutable implementation of ModalViewPayloadIF.
Use the builder to create immutable instances: ModalViewPayload.builder(). Use the static factory method to create immutable instances: ModalViewPayload.of().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ModalViewPayload.Builder
Builds instances of type ModalViewPayload.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModalViewPayload.Builder` Builds instances of type `ModalViewPayload`.

Field Summary
- Fields inherited from interface com.hubspot.slack.client.models.views.ModalViewPayloadBase
  TYPE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ModalViewPayload.Builder`	`builder()` Creates a builder for `ModalViewPayload`.
`static ModalViewPayload`	`copyOf(ModalViewPayloadIF instance)` Creates an immutable copy of a `ModalViewPayloadIF` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ModalViewPayload` that have equal attribute values.
`List<Block>`	`getBlocks()`
`Optional<String>`	`getCallbackId()`
`Optional<Boolean>`	`getClearOnClose()`
`Optional<Text>`	`getCloseButtonText()`
`Optional<String>`	`getExternalId()`
`Optional<Boolean>`	`getNotifyOnClose()`
`Optional<String>`	`getPrivateMetadata()`
`Optional<Text>`	`getSubmitButtonText()`
`Text`	`getTitle()`
`String`	`getType()`
`int`	`hashCode()` Computes a hash code from attributes: `title`, `blocks`, `type`, `closeButtonText`, `submitButtonText`, `clearOnClose`, `notifyOnClose`, `privateMetadata`, `callbackId`, `externalId`.
`static ModalViewPayload`	`of(Text title, Iterable<? extends Block> blocks)` Construct a new immutable `ModalViewPayload` instance.
`static ModalViewPayload`	`of(Text title, List<Block> blocks)` Construct a new immutable `ModalViewPayload` instance.
`String`	`toString()` Prints the immutable value `ModalViewPayload` with attribute values.
`ModalViewPayload`	`withBlocks(Block... elements)` Copy the current immutable object with elements that replace the content of `blocks`.
`ModalViewPayload`	`withBlocks(Iterable<? extends Block> elements)` Copy the current immutable object with elements that replace the content of `blocks`.
`ModalViewPayload`	`withCallbackId(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `callbackId` attribute.
`ModalViewPayload`	`withCallbackId(String value)` Copy the current immutable object by setting a present value for the optional `callbackId` attribute.
`ModalViewPayload`	`withClearOnClose(Boolean value)` Copy the current immutable object by setting a present value for the optional `clearOnClose` attribute.
`ModalViewPayload`	`withClearOnClose(Optional<Boolean> optional)` Copy the current immutable object by setting an optional value for the `clearOnClose` attribute.
`ModalViewPayload`	`withCloseButtonText(Optional<Text> optional)` Copy the current immutable object by setting an optional value for the `closeButtonText` attribute.
`ModalViewPayload`	`withCloseButtonText(Text value)` Copy the current immutable object by setting a present value for the optional `closeButtonText` attribute.
`ModalViewPayload`	`withExternalId(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `externalId` attribute.
`ModalViewPayload`	`withExternalId(String value)` Copy the current immutable object by setting a present value for the optional `externalId` attribute.
`ModalViewPayload`	`withNotifyOnClose(Boolean value)` Copy the current immutable object by setting a present value for the optional `notifyOnClose` attribute.
`ModalViewPayload`	`withNotifyOnClose(Optional<Boolean> optional)` Copy the current immutable object by setting an optional value for the `notifyOnClose` attribute.
`ModalViewPayload`	`withPrivateMetadata(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `privateMetadata` attribute.
`ModalViewPayload`	`withPrivateMetadata(String value)` Copy the current immutable object by setting a present value for the optional `privateMetadata` attribute.
`ModalViewPayload`	`withSubmitButtonText(Optional<Text> optional)` Copy the current immutable object by setting an optional value for the `submitButtonText` attribute.
`ModalViewPayload`	`withSubmitButtonText(Text value)` Copy the current immutable object by setting a present value for the optional `submitButtonText` attribute.
`ModalViewPayload`	`withTitle(Text title)` Copy the current immutable object by setting a value for the `title` attribute.

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

- Method Detail
  - getTitle
```
public Text getTitle()
```
    Specified by:
    
    getTitle in interface ModalViewPayloadBase
    
    Specified by:
    
    getTitle in interface ModalViewPayloadIF
    
    Returns:
    
    The value of the title attribute
  - getBlocks
```
public List<Block> getBlocks()
```
    Specified by:
    
    getBlocks in interface ModalViewPayloadIF
    
    Specified by:
    
    getBlocks in interface ViewPayloadBase
    
    Returns:
    
    The value of the blocks attribute
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface ModalViewPayloadBase
    
    Specified by:
    
    getType in interface ViewPayloadBase
    
    Returns:
    
    The computed-at-construction value of the type attribute
  - getCloseButtonText
```
public Optional<Text> getCloseButtonText()
```
    Specified by:
    
    getCloseButtonText in interface ModalViewPayloadBase
    
    Returns:
    
    The value of the closeButtonText attribute
  - getSubmitButtonText
```
public Optional<Text> getSubmitButtonText()
```
    Specified by:
    
    getSubmitButtonText in interface ModalViewPayloadBase
    
    Returns:
    
    The value of the submitButtonText attribute
  - getClearOnClose
```
public Optional<Boolean> getClearOnClose()
```
    Specified by:
    
    getClearOnClose in interface ModalViewPayloadBase
    
    Returns:
    
    The value of the clearOnClose attribute
  - getNotifyOnClose
```
public Optional<Boolean> getNotifyOnClose()
```
    Specified by:
    
    getNotifyOnClose in interface ModalViewPayloadBase
    
    Returns:
    
    The value of the notifyOnClose attribute
  - getPrivateMetadata
```
public Optional<String> getPrivateMetadata()
```
    Specified by:
    
    getPrivateMetadata in interface ViewPayloadBase
    
    Returns:
    
    The value of the privateMetadata attribute
  - getCallbackId
```
public Optional<String> getCallbackId()
```
    Specified by:
    
    getCallbackId in interface ViewPayloadBase
    
    Returns:
    
    The value of the callbackId attribute
  - getExternalId
```
public Optional<String> getExternalId()
```
    Specified by:
    
    getExternalId in interface ViewPayloadBase
    
    Returns:
    
    The value of the externalId attribute
  - withTitle
```
public final ModalViewPayload withTitle(Text title)
```
    Copy the current immutable object by setting a value for the title attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    title - A new value for title
    
    Returns:
    
    A modified copy of the this object
  - withBlocks
```
public final ModalViewPayload withBlocks(Block... elements)
```
    Copy the current immutable object with elements that replace the content of blocks.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withBlocks
```
public final ModalViewPayload withBlocks(Iterable<? extends Block> elements)
```
    Copy the current immutable object with elements that replace the content of blocks. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of blocks elements to set
    
    Returns:
    
    A modified copy of this object
  - withCloseButtonText
```
public final ModalViewPayload withCloseButtonText(@Nullable
                                                  Text value)
```
    Copy the current immutable object by setting a present value for the optional closeButtonText attribute.
    
    Parameters:
    
    value - The value for closeButtonText, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withCloseButtonText
```
public final ModalViewPayload withCloseButtonText(Optional<Text> optional)
```
    Copy the current immutable object by setting an optional value for the closeButtonText attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for closeButtonText
    
    Returns:
    
    A modified copy of this object
  - withSubmitButtonText
```
public final ModalViewPayload withSubmitButtonText(@Nullable
                                                   Text value)
```
    Copy the current immutable object by setting a present value for the optional submitButtonText attribute.
    
    Parameters:
    
    value - The value for submitButtonText, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withSubmitButtonText
```
public final ModalViewPayload withSubmitButtonText(Optional<Text> optional)
```
    Copy the current immutable object by setting an optional value for the submitButtonText attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for submitButtonText
    
    Returns:
    
    A modified copy of this object
  - withClearOnClose
```
public final ModalViewPayload withClearOnClose(@Nullable
                                               Boolean value)
```
    Copy the current immutable object by setting a present value for the optional clearOnClose attribute.
    
    Parameters:
    
    value - The value for clearOnClose, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withClearOnClose
```
public final ModalViewPayload withClearOnClose(Optional<Boolean> optional)
```
    Copy the current immutable object by setting an optional value for the clearOnClose attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for clearOnClose
    
    Returns:
    
    A modified copy of this object
  - withNotifyOnClose
```
public final ModalViewPayload withNotifyOnClose(@Nullable
                                                Boolean value)
```
    Copy the current immutable object by setting a present value for the optional notifyOnClose attribute.
    
    Parameters:
    
    value - The value for notifyOnClose, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withNotifyOnClose
```
public final ModalViewPayload withNotifyOnClose(Optional<Boolean> optional)
```
    Copy the current immutable object by setting an optional value for the notifyOnClose attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for notifyOnClose
    
    Returns:
    
    A modified copy of this object
  - withPrivateMetadata
```
public final ModalViewPayload withPrivateMetadata(@Nullable
                                                  String value)
```
    Copy the current immutable object by setting a present value for the optional privateMetadata attribute.
    
    Parameters:
    
    value - The value for privateMetadata, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withPrivateMetadata
```
public final ModalViewPayload withPrivateMetadata(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the privateMetadata attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for privateMetadata
    
    Returns:
    
    A modified copy of this object
  - withCallbackId
```
public final ModalViewPayload withCallbackId(@Nullable
                                             String value)
```
    Copy the current immutable object by setting a present value for the optional callbackId attribute.
    
    Parameters:
    
    value - The value for callbackId, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withCallbackId
```
public final ModalViewPayload withCallbackId(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the callbackId attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for callbackId
    
    Returns:
    
    A modified copy of this object
  - withExternalId
```
public final ModalViewPayload withExternalId(@Nullable
                                             String value)
```
    Copy the current immutable object by setting a present value for the optional externalId attribute.
    
    Parameters:
    
    value - The value for externalId, null is accepted as java.util.Optional.empty()
    
    Returns:
    
    A modified copy of this object
  - withExternalId
```
public final ModalViewPayload withExternalId(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the externalId attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for externalId
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ModalViewPayload that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: title, blocks, type, closeButtonText, submitButtonText, clearOnClose, notifyOnClose, privateMetadata, callbackId, externalId.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ModalViewPayload with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static ModalViewPayload of(Text title,
                                  List<Block> blocks)
```
    Construct a new immutable ModalViewPayload instance.
    
    Parameters:
    
    title - The value for the title attribute
    
    blocks - The value for the blocks attribute
    
    Returns:
    
    An immutable ModalViewPayload instance
  - of
```
public static ModalViewPayload of(Text title,
                                  Iterable<? extends Block> blocks)
```
    Construct a new immutable ModalViewPayload instance.
    
    Parameters:
    
    title - The value for the title attribute
    
    blocks - The value for the blocks attribute
    
    Returns:
    
    An immutable ModalViewPayload instance
  - copyOf
```
public static ModalViewPayload copyOf(ModalViewPayloadIF instance)
```
    Creates an immutable copy of a ModalViewPayloadIF value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable ModalViewPayload instance
  - builder
```
public static ModalViewPayload.Builder builder()
```
    Creates a builder for ModalViewPayload.
    
    Returns:
    
    A new ModalViewPayload builder

Class ModalViewPayload

Nested Class Summary

Field Summary

Fields inherited from interface com.hubspot.slack.client.models.views.ModalViewPayloadBase

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTitle

getBlocks

getType

getCloseButtonText

getSubmitButtonText

getClearOnClose

getNotifyOnClose

getPrivateMetadata

getCallbackId

getExternalId

withTitle

withBlocks

withBlocks

withCloseButtonText

withCloseButtonText

withSubmitButtonText

withSubmitButtonText

withClearOnClose

withClearOnClose

withNotifyOnClose

withNotifyOnClose

withPrivateMetadata

withPrivateMetadata

withCallbackId

withCallbackId

withExternalId

withExternalId

equals

hashCode

toString

of

of

copyOf

builder