Class CommandNotificationMessage

  • All Implemented Interfaces:

    
    public class CommandNotificationMessage
    
                        

    Command Reminder Message Class

    This is a command message class. Messages of this type are stored but do not count towards unread message numbers. The difference from CommandMessage is that this message is stored and displayed in the UI.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      public String name
      public String data
      public final static Creator<CommandNotificationMessage> CREATOR
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      String getName() Retrieves the command name.
      void setName(String name) Sets the command name.
      String getData() Retrieves command data, which can be in any format, such as JSON.
      void setData(String data) Sets the command data, which can be in any format, such as JSON.
      static CommandNotificationMessage obtain(String name, String data) Creates a message instance.
      Array<byte> encode()
      void writeToParcel(Parcel dest, int flags) Writes the class data into the provided Parcel.
      int describeContents() Describes the type of special objects included in the arrangement information of the Parcelable object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CommandNotificationMessage

        CommandNotificationMessage(Array<byte> data)
      • CommandNotificationMessage

        CommandNotificationMessage(Parcel in)
    • Method Detail

      • getName

         String getName()

        Retrieves the command name.

        Returns:

        The command name.

      • setName

         void setName(String name)

        Sets the command name.

        Parameters:
        name - The command name.
      • getData

         String getData()

        Retrieves command data, which can be in any format, such as JSON.

        Returns:

        Command data, which can be in any format, such as JSON.

      • setData

         void setData(String data)

        Sets the command data, which can be in any format, such as JSON.

        Parameters:
        data - Command data, which can be in any format, such as JSON.
      • obtain

         static CommandNotificationMessage obtain(String name, String data)

        Creates a message instance.

        Parameters:
        name - The command name to be retrieved.
        data - The command data to be set, which can be in any format, such as JSON.
        Returns:

        The message instance.

      • writeToParcel

         void writeToParcel(Parcel dest, int flags)

        Writes the class data into the provided Parcel.

        Parameters:
        dest - The Parcel into which the object is written.
        flags - Additional flags about how the object should be written, possibly 0 or PARCELABLE_WRITE_RETURN_VALUE.
      • describeContents

         int describeContents()

        Describes the type of special objects included in the arrangement information of the Parcelable object.

        Returns:

        A flag indicating the arrangement of the special object type collection in the Parcelable object.