Class GCMMessage.Builder

  • Enclosing class:
    GCMMessage

    public static class GCMMessage.Builder
    extends java.lang.Object
    Builder of GCMMessage.
    • Method Detail

      • build

        @NonNull
        public GCMMessage build()
        Build and return GCMMessage.
        Throws:
        java.lang.IllegalStateException - Thrown if data contains one or more keys that are GCM reserve word mentioned in KiiPushMessage.Data.
      • withRestrictedPackageName

        @NonNull
        public GCMMessage.Builder withRestrictedPackageName​(@Nullable
                                                            java.lang.String restrictedPackageName)
        Send restricted package name which is a string containing the package name of the application. When set, messages will only be sent to registration IDs that match the package name. Corresponding to GCM's "restricted_package_name" For details please refer to GCM document
        Parameters:
        restrictedPackageName - package name.
      • withTimeToLive

        @NonNull
        public GCMMessage.Builder withTimeToLive​(int timeToLive)
        Indicates how long (in seconds) the message should be kept on GCM storage if the device is offline. Corresponding to GCM's "time_to_live" property. For details please refer to GCM document
        Parameters:
        timeToLive - time(in seconds).
      • withCollapseKey

        @NonNull
        public GCMMessage.Builder withCollapseKey​(@Nullable
                                                  java.lang.String collapseKey)
        Build with collapse key. Send the message with collapse key which is an arbitrary string that is used to collapse a group of like messages when the device is offline, so that only the last message gets sent to the client. Corresponding to GCM's 'collapse_key' For details please refer to GCM document
        Parameters:
        collapseKey - Arbitrary string that is used as collapse key.
      • delayWhileIdle

        @NonNull
        public GCMMessage.Builder delayWhileIdle​(boolean delayWhileIdle)
        Build with the flag of delay while device is idle. Corresponding to GCM's 'delay_while_idle'. For details please refer to GCM document
        Parameters:
        delayWhileIdle - If true, the message will not be sent immediately if the device is idle.