Class Message


  • public class Message
    extends java.lang.Object
    Message

    An object defining the properties of a single message

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Message.Builder  
    • Constructor Summary

      Constructors 
      Constructor Description
      Message()  
      Message​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid, java.util.Optional<? extends MessageType> type, java.util.Optional<java.lang.String> recipient, org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender, org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts, org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate, org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate, java.util.Optional<java.lang.String> statusCode, java.util.Optional<java.lang.String> statusDescription, java.util.Optional<java.lang.Boolean> unicode, java.util.Optional<java.lang.Boolean> flash, java.util.Optional<java.lang.Float> price)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Message.Builder builder()  
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid()
      Custom message ID assigned by the User
      boolean equals​(java.lang.Object o)  
      java.util.Optional<java.lang.Boolean> flash()
      Was the message sent with class 0 (FLASH)?
      int hashCode()  
      org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id()
      Unique message identifier
      org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts()
      The count of parts that message consists of
      java.util.Optional<java.lang.Float> price()
      The price of message (in PLN)
      java.util.Optional<java.lang.String> recipient()
      A telephone number in international format (with a plus sign and the country code at the beginning, e.g.
      org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender()
      Message sender name
      org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate()
      Sending date and time (in ISO 8601 format)
      java.util.Optional<java.lang.String> statusCode()
      Message status code
      org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate()
      Date and time of last status change (in ISO 8601 format)
      java.util.Optional<java.lang.String> statusDescription()
      Human redable description of message status
      java.lang.String toString()  
      java.util.Optional<MessageType> type()
      Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      java.util.Optional<java.lang.Boolean> unicode()
      Did the message contain special characters, e.g.
      Message withCid​(java.lang.String cid)
      Custom message ID assigned by the User
      Message withCid​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid)
      Custom message ID assigned by the User
      Message withFlash​(boolean flash)
      Was the message sent with class 0 (FLASH)?
      Message withFlash​(java.util.Optional<java.lang.Boolean> flash)
      Was the message sent with class 0 (FLASH)?
      Message withId​(long id)
      Unique message identifier
      Message withId​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id)
      Unique message identifier
      Message withParts​(long parts)
      The count of parts that message consists of
      Message withParts​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts)
      The count of parts that message consists of
      Message withPrice​(float price)
      The price of message (in PLN)
      Message withPrice​(java.util.Optional<java.lang.Float> price)
      The price of message (in PLN)
      Message withRecipient​(java.lang.String recipient)
      A telephone number in international format (with a plus sign and the country code at the beginning, e.g.
      Message withRecipient​(java.util.Optional<java.lang.String> recipient)
      A telephone number in international format (with a plus sign and the country code at the beginning, e.g.
      Message withSender​(java.lang.String sender)
      Message sender name
      Message withSender​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender)
      Message sender name
      Message withSentDate​(java.time.OffsetDateTime sentDate)
      Sending date and time (in ISO 8601 format)
      Message withSentDate​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate)
      Sending date and time (in ISO 8601 format)
      Message withStatusCode​(java.lang.String statusCode)
      Message status code
      Message withStatusCode​(java.util.Optional<java.lang.String> statusCode)
      Message status code
      Message withStatusDate​(java.time.OffsetDateTime statusDate)
      Date and time of last status change (in ISO 8601 format)
      Message withStatusDate​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate)
      Date and time of last status change (in ISO 8601 format)
      Message withStatusDescription​(java.lang.String statusDescription)
      Human redable description of message status
      Message withStatusDescription​(java.util.Optional<java.lang.String> statusDescription)
      Human redable description of message status
      Message withType​(java.util.Optional<? extends MessageType> type)
      Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      Message withType​(MessageType type)
      Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      Message withUnicode​(boolean unicode)
      Did the message contain special characters, e.g.
      Message withUnicode​(java.util.Optional<java.lang.Boolean> unicode)
      Did the message contain special characters, e.g.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Message

        public Message​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id,
                       org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid,
                       java.util.Optional<? extends MessageType> type,
                       java.util.Optional<java.lang.String> recipient,
                       org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender,
                       org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts,
                       org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate,
                       org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate,
                       java.util.Optional<java.lang.String> statusCode,
                       java.util.Optional<java.lang.String> statusDescription,
                       java.util.Optional<java.lang.Boolean> unicode,
                       java.util.Optional<java.lang.Boolean> flash,
                       java.util.Optional<java.lang.Float> price)
      • Message

        public Message()
    • Method Detail

      • id

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id()
        Unique message identifier
      • cid

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid()
        Custom message ID assigned by the User
      • type

        public java.util.Optional<MessageType> type()
        Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      • recipient

        public java.util.Optional<java.lang.String> recipient()
        A telephone number in international format (with a plus sign and the country code at the beginning, e.g. +48 for Poland)
      • sender

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender()
        Message sender name
      • parts

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts()
        The count of parts that message consists of
      • sentDate

        public org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate()
        Sending date and time (in ISO 8601 format)
      • statusDate

        public org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate()
        Date and time of last status change (in ISO 8601 format)
      • statusCode

        public java.util.Optional<java.lang.String> statusCode()
        Message status code
      • statusDescription

        public java.util.Optional<java.lang.String> statusDescription()
        Human redable description of message status
      • unicode

        public java.util.Optional<java.lang.Boolean> unicode()
        Did the message contain special characters, e.g. Polish diacritics?
      • flash

        public java.util.Optional<java.lang.Boolean> flash()
        Was the message sent with class 0 (FLASH)?
      • price

        public java.util.Optional<java.lang.Float> price()
        The price of message (in PLN)
      • withId

        public Message withId​(long id)
        Unique message identifier
      • withId

        public Message withId​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> id)
        Unique message identifier
      • withCid

        public Message withCid​(java.lang.String cid)
        Custom message ID assigned by the User
      • withCid

        public Message withCid​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> cid)
        Custom message ID assigned by the User
      • withType

        public Message withType​(MessageType type)
        Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      • withType

        public Message withType​(java.util.Optional<? extends MessageType> type)
        Message type (SmsType.SmsPro -> SMS PRO, SmsType.SmsEco -> SMS ECO, SmsType.SmsTwoWay ->SMS 2WAY, SmsType.Mms -> MMS)
      • withRecipient

        public Message withRecipient​(java.lang.String recipient)
        A telephone number in international format (with a plus sign and the country code at the beginning, e.g. +48 for Poland)
      • withRecipient

        public Message withRecipient​(java.util.Optional<java.lang.String> recipient)
        A telephone number in international format (with a plus sign and the country code at the beginning, e.g. +48 for Poland)
      • withSender

        public Message withSender​(java.lang.String sender)
        Message sender name
      • withSender

        public Message withSender​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> sender)
        Message sender name
      • withParts

        public Message withParts​(long parts)
        The count of parts that message consists of
      • withParts

        public Message withParts​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Long> parts)
        The count of parts that message consists of
      • withSentDate

        public Message withSentDate​(java.time.OffsetDateTime sentDate)
        Sending date and time (in ISO 8601 format)
      • withSentDate

        public Message withSentDate​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> sentDate)
        Sending date and time (in ISO 8601 format)
      • withStatusDate

        public Message withStatusDate​(java.time.OffsetDateTime statusDate)
        Date and time of last status change (in ISO 8601 format)
      • withStatusDate

        public Message withStatusDate​(org.openapitools.jackson.nullable.JsonNullable<java.time.OffsetDateTime> statusDate)
        Date and time of last status change (in ISO 8601 format)
      • withStatusCode

        public Message withStatusCode​(java.lang.String statusCode)
        Message status code
      • withStatusCode

        public Message withStatusCode​(java.util.Optional<java.lang.String> statusCode)
        Message status code
      • withStatusDescription

        public Message withStatusDescription​(java.lang.String statusDescription)
        Human redable description of message status
      • withStatusDescription

        public Message withStatusDescription​(java.util.Optional<java.lang.String> statusDescription)
        Human redable description of message status
      • withUnicode

        public Message withUnicode​(boolean unicode)
        Did the message contain special characters, e.g. Polish diacritics?
      • withUnicode

        public Message withUnicode​(java.util.Optional<java.lang.Boolean> unicode)
        Did the message contain special characters, e.g. Polish diacritics?
      • withFlash

        public Message withFlash​(boolean flash)
        Was the message sent with class 0 (FLASH)?
      • withFlash

        public Message withFlash​(java.util.Optional<java.lang.Boolean> flash)
        Was the message sent with class 0 (FLASH)?
      • withPrice

        public Message withPrice​(float price)
        The price of message (in PLN)
      • withPrice

        public Message withPrice​(java.util.Optional<java.lang.Float> price)
        The price of message (in PLN)
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object