Package com.vonage.client.users

Class User.Builder

java.lang.Object
com.vonage.client.users.User.Builder
Enclosing class:
User
public static class User.Builder extends Object

  • Method Details

    • name

      public User.Builder name(String name)
      Unique name for a user.
      Parameters:
      name - The user's name.
      Returns:
      This builder.

    • displayName

      public User.Builder displayName(String displayName)
      Set the display name for the user. This does nbot need to be unique.
      Parameters:
      displayName - The user's display name.
      Returns:
      This builder.

    • imageUrl

      public User.Builder imageUrl(String imageUrl)
      An image URL to associate with the user.
      Parameters:
      imageUrl - The image URL as a string.
      Returns:
      This builder.

    • customData

      public User.Builder customData(Map<String,?> customData)
      Arbitrary freeform data to associate with the user. Note that this is not additive: the value set here will replace any existing custom data when updating a user.
      Parameters:
      customData - Custom key/value pairs map.
      Returns:
      This builder.

    • channels

      public User.Builder channels(Channel... channels)
      Sets the communication channels for this user.
      Parameters:
      channels - The channels to associate with the user.
      Returns:
      This builder.

    • channels

      public User.Builder channels(Collection<? extends Channel> channels)
      Sets the communication channels for this user.
      Parameters:
      channels - The collection of channels to associate with the user.
      Returns:
      This builder.

    • build

      public User build()
      Builds the Application object.
      Returns:
      A new Application containing the configured properties.