Package pl.gsmservice.gateway.models.components

Class Sms.Builder

  • Enclosing class:
    Sms
    public static final class Sms.Builder
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Sms build()  
      Sms.Builder date​(java.time.OffsetDateTime date)
      Scheduled future date and time of sending the message (in ISO 8601 format).
      Sms.Builder date​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> date)
      Scheduled future date and time of sending the message (in ISO 8601 format).
      Sms.Builder flash​(boolean flash)
      Should the message to be sent with class 0 (FLASH)?
      Sms.Builder flash​(java.util.Optional<java.lang.Boolean> flash)
      Should the message to be sent with class 0 (FLASH)?
      Sms.Builder message​(java.lang.String message)
      SMS message content
      Sms.Builder recipients​(Recipients recipients)
      The recipient number or multiple recipients numbers of single message.
      Sms.Builder sender​(java.lang.String sender)
      SMS sender name
      Sms.Builder sender​(java.util.Optional<java.lang.String> sender)
      SMS sender name
      Sms.Builder type​(java.util.Optional<? extends SmsType> type)
      SMS type according to the table |type|Description| |----|-----------| | 1 | SMS PRO | | 3 | SMS ECO | | 4 | SMS 2WAY |
      Sms.Builder type​(SmsType type)
      SMS type according to the table |type|Description| |----|-----------| | 1 | SMS PRO | | 3 | SMS ECO | | 4 | SMS 2WAY |
      Sms.Builder unicode​(boolean unicode)
      Should the message be sent with special characters, e.g.
      Sms.Builder unicode​(java.util.Optional<java.lang.Boolean> unicode)
      Should the message be sent with special characters, e.g.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • recipients

        public Sms.Builder recipients​(Recipients recipients)
        The recipient number or multiple recipients numbers of single message. To set one recipient, simply pass here a `string` with his phone number. To set multiple recipients, pass here a simple `array` of `string`. Optionally you can also set custom id (user identifier) for each message - pass `PhoneNumberWithCid` object (in case of single recipient) or `Array` of `PhoneNumberWithCid` (in case of multiple recipients).

      • message

        public Sms.Builder message​(java.lang.String message)
        SMS message content

      • sender

        public Sms.Builder sender​(java.lang.String sender)
        SMS sender name

      • sender

        public Sms.Builder sender​(java.util.Optional<java.lang.String> sender)
        SMS sender name

      • type

        public Sms.Builder type​(SmsType type)
        SMS type according to the table |type|Description| |----|-----------| | 1 | SMS PRO | | 3 | SMS ECO | | 4 | SMS 2WAY |

      • type

        public Sms.Builder type​(java.util.Optional<? extends SmsType> type)
        SMS type according to the table |type|Description| |----|-----------| | 1 | SMS PRO | | 3 | SMS ECO | | 4 | SMS 2WAY |

      • unicode

        public Sms.Builder unicode​(boolean unicode)
        Should the message be sent with special characters, e.g. Polish diacritics (if any)? If *false*, those characters will be automatically replaced with their equivalents. If *true* your message will be sent as **unicode** but the message will be able to consist of fewer characters.

      • unicode

        public Sms.Builder unicode​(java.util.Optional<java.lang.Boolean> unicode)
        Should the message be sent with special characters, e.g. Polish diacritics (if any)? If *false*, those characters will be automatically replaced with their equivalents. If *true* your message will be sent as **unicode** but the message will be able to consist of fewer characters.

      • flash

        public Sms.Builder flash​(boolean flash)
        Should the message to be sent with class 0 (FLASH)?

      • flash

        public Sms.Builder flash​(java.util.Optional<java.lang.Boolean> flash)
        Should the message to be sent with class 0 (FLASH)?

      • date

        public Sms.Builder date​(java.time.OffsetDateTime date)
        Scheduled future date and time of sending the message (in ISO 8601 format). If missing or null - message will be sent immediately

      • date

        public Sms.Builder date​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> date)
        Scheduled future date and time of sending the message (in ISO 8601 format). If missing or null - message will be sent immediately

      • build

        public Sms build()