Package com.microstrategy.web.objects

Interface WebSubscriptionProperties

  • All Known Subinterfaces:
    WebSubscription
    public interface WebSubscriptionProperties
    This interface defines various subscription related properties
    Since:
    MicroStrategy Web 7.5.1

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBadgeMetricId()
      get metric id used to update badge This API is only available with valid information for single content subscription
      int getBurstingLowerBound()
      Get the bursting subscription's lower bound.
      int getBurstingUpperBound()
      Get the bursting subscription's upper bound.
      WebSubscriptionContentProperties getContentProperties()
      Retrieves the associated WebSubscriptionContentProperties This API is only available with valid information for single content subscription
      WebSubscriptionContentProperties getContentPropertiesMCS​(int key)
      Retrieves the associated WebSubscriptionContentProperties by key This API is only available with valid information for multiple content subscription
      java.lang.String getCreationTime()
      Retrieves the time the subscription was first saved to the IServer
      java.lang.String getCustomMessage()
      Retrieves the associated custom message This API is only available with valid information for single content subscription
      WebSubscriptionDeliveryModeProperties getDeliveryMode()
      Retrieves the associated WebSubscriptionDeliveryModeProperties
      java.lang.String getModificationTime()
      Retrieves the last modified time of the subscription
      boolean isBursting()
      Indicate if it's a bursting subscription This API is only available with valid information for single content subscription
      boolean isPushNotify()
      Indicate if user's push notification or not
      boolean isSendNowSet()
      Reads the boolean property indicating whether the result of the subscription will be sent to the subscriber immediately
      boolean isUpdateBadge()
      Indicate if user update badge or not This API is only available with valid information for single content subscription
      void setBadgeMetricId​(java.lang.String badgeMetricId)
      Set badge metric ID which used to update badge This API is only available with valid information for single content subscription
      void setBurstingLowerBound​(int lowerBound)
      Set the bursting subscription's lower bound.
      void setBurstingUpperBound​(int upperBound)
      Set the bursting subscription's upper bound.
      void setCustomMessage​(java.lang.String message)
      Defines the custom message, which is any string that can attached to the actual This API is only available with valid information for single content subscription content that will be delivered.
      void setIsBursting​(boolean isBursting)
      Sets the boolean property indicating whether the subscription should be bursting This API is only available with valid information for single content subscription
      void setIsPushNotify​(boolean isNotify)
      Set if user's push notification or not
      void setIsUpdateBadge​(boolean isUpdate)
      Set if user update badge or not This API is only available with valid information for single content subscription
      void setSendNow​(boolean sendNow)
      Sets the boolean property indicating whether the result of the subscription should be sent to the subscriber immediately

    • Method Detail

      • setSendNow

        void setSendNow​(boolean sendNow)
        Sets the boolean property indicating whether the result of the subscription should be sent to the subscriber immediately
        Parameters:
        sendNow - boolean

      • isSendNowSet

        boolean isSendNowSet()
        Reads the boolean property indicating whether the result of the subscription will be sent to the subscriber immediately
        Returns:
        boolean

      • setCustomMessage

        void setCustomMessage​(java.lang.String message)
        Defines the custom message, which is any string that can attached to the actual This API is only available with valid information for single content subscription content that will be delivered.
        Parameters:
        message -

      • getCustomMessage

        java.lang.String getCustomMessage()
        Retrieves the associated custom message This API is only available with valid information for single content subscription
        Returns:
        the associated custom message

      • isPushNotify

        boolean isPushNotify()
        Indicate if user's push notification or not
        Returns:
        if user's push notification or not

      • setIsPushNotify

        void setIsPushNotify​(boolean isNotify)
        Set if user's push notification or not
        Parameters:
        isNotify -

      • isUpdateBadge

        boolean isUpdateBadge()
        Indicate if user update badge or not This API is only available with valid information for single content subscription
        Returns:
        if user update badge or not

      • setIsUpdateBadge

        void setIsUpdateBadge​(boolean isUpdate)
        Set if user update badge or not This API is only available with valid information for single content subscription
        Parameters:
        isUpdate -
        See Also:
        isUpdateBadge()

      • getBadgeMetricId

        java.lang.String getBadgeMetricId()
        get metric id used to update badge This API is only available with valid information for single content subscription
        Returns:
        metric id used to update badge

      • setBadgeMetricId

        void setBadgeMetricId​(java.lang.String badgeMetricId)
        Set badge metric ID which used to update badge This API is only available with valid information for single content subscription
        Parameters:
        badgeMetricId -
        See Also:
        getBadgeMetricId()

      • getModificationTime

        java.lang.String getModificationTime()
        Retrieves the last modified time of the subscription
        Returns:
        the last modified time of the subscription
        Since:
        MicroStrategy Web 9.0.0

      • getCreationTime

        java.lang.String getCreationTime()
        Retrieves the time the subscription was first saved to the IServer
        Returns:
        String containing the creation time of the subscription

      • isBursting

        boolean isBursting()
        Indicate if it's a bursting subscription This API is only available with valid information for single content subscription
        Returns:
        boolean Indicate if it's a bursting subscription

      • setIsBursting

        void setIsBursting​(boolean isBursting)
        Sets the boolean property indicating whether the subscription should be bursting This API is only available with valid information for single content subscription
        Parameters:
        isBursting -

      • setBurstingUpperBound

        void setBurstingUpperBound​(int upperBound)
        Set the bursting subscription's upper bound. This API is only available with valid information for single content subscription
        Parameters:
        upperBound -

      • getBurstingUpperBound

        int getBurstingUpperBound()
        Get the bursting subscription's upper bound. This API is only available with valid information for single content subscription
        Returns:
        upper bound of a bursting subscription.

      • setBurstingLowerBound

        void setBurstingLowerBound​(int lowerBound)
        Set the bursting subscription's lower bound. This API is only available with valid information for single content subscription
        Parameters:
        lowerBound -

      • getBurstingLowerBound

        int getBurstingLowerBound()
        Get the bursting subscription's lower bound. This API is only available with valid information for single content subscription
        Returns:
        lower bound of a bursting subscription.