WebSubscriptionProperties
| com.microstrategy.web.objects.WebSubscriptionProperties |
 Known Indirect Subclasses
|
Class Overview
This interface defines various subscription related properties
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String |
getBadgeMetricId()
get metric id used to update badge
| ||||||||||
| abstract int |
getBurstingLowerBound()
Get the bursting subscription's lower bound.
| ||||||||||
| abstract int |
getBurstingUpperBound()
Get the bursting subscription's upper bound.
| ||||||||||
| abstract WebSubscriptionContentProperties |
getContentProperties()
Retrieves the associated
WebSubscriptionContentProperties | ||||||||||
| abstract String |
getCreationTime()
Retrieves the time the subscription was first saved to the IServer
| ||||||||||
| abstract String |
getCustomMessage()
Retrieves the associated custom message
| ||||||||||
| abstract WebSubscriptionDeliveryModeProperties |
getDeliveryMode()
Retrieves the associated
WebSubscriptionDeliveryModeProperties | ||||||||||
| abstract String |
getModificationTime()
Retrieves the last modified time of the subscription
| ||||||||||
| abstract boolean |
isBursting()
Indicate if it's a bursting subscription
| ||||||||||
| abstract boolean |
isPushNotify()
Indicate if user's push notification or not
| ||||||||||
| abstract boolean |
isSendNowSet()
Reads the boolean property indicating whether the result of the subscription will
be sent to the subscriber immediately
| ||||||||||
| abstract boolean |
isUpdateBadge()
Indicate if user update badge or not
| ||||||||||
| abstract void |
setBadgeMetricId(String badgeMetricId)
Set badge metric ID which used to update badge
| ||||||||||
| abstract void |
setBurstingLowerBound(int lowerBound)
Set the bursting subscription's lower bound.
| ||||||||||
| abstract void |
setBurstingUpperBound(int upperBound)
Set the bursting subscription's upper bound.
| ||||||||||
| abstract void |
setCustomMessage(String message)
Defines the custom message, which is any string that can attached to the actual
content that will be delivered.
| ||||||||||
| abstract void |
setIsBursting(boolean isBursting)
Sets the boolean property indicating whether the subscription should
be bursting
| ||||||||||
| abstract void |
setIsPushNotify(boolean isNotify)
Set if user's push notification or not
| ||||||||||
| abstract void |
setIsUpdateBadge(boolean isUpdate)
Set if user update badge or not
| ||||||||||
| abstract void |
setSendNow(boolean sendNow)
Sets the boolean property indicating whether the result of the subscription should
be sent to the subscriber immediately
| ||||||||||
Public Methods
public abstract String getBadgeMetricId ()
get metric id used to update badge
Returns
- metric id used to update badge
public abstract int getBurstingLowerBound ()
Get the bursting subscription's lower bound.
Returns
- lower bound of a bursting subscription.
public abstract int getBurstingUpperBound ()
Get the bursting subscription's upper bound.
Returns
- upper bound of a bursting subscription.
public abstract WebSubscriptionContentProperties getContentProperties ()
Retrieves the associated WebSubscriptionContentProperties
Returns
- the associated
WebSubscriptionContentProperties
public abstract String getCreationTime ()
Retrieves the time the subscription was first saved to the IServer
Returns
- String containing the creation time of the subscription
public abstract String getCustomMessage ()
Retrieves the associated custom message
Returns
- the associated custom message
public abstract WebSubscriptionDeliveryModeProperties getDeliveryMode ()
Retrieves the associated WebSubscriptionDeliveryModeProperties
Returns
- the associated
WebSubscriptionDeliveryModeProperties
public abstract String getModificationTime ()
Retrieves the last modified time of the subscription
Returns
- the last modified time of the subscription
public abstract boolean isBursting ()
Indicate if it's a bursting subscription
Returns
- boolean Indicate if it's a bursting subscription
public abstract boolean isPushNotify ()
Indicate if user's push notification or not
Returns
- if user's push notification or not
public abstract boolean isSendNowSet ()
Reads the boolean property indicating whether the result of the subscription will be sent to the subscriber immediately
Returns
- boolean
public abstract boolean isUpdateBadge ()
Indicate if user update badge or not
Returns
- if user update badge or not
public abstract void setBadgeMetricId (String badgeMetricId)
Set badge metric ID which used to update badge
See Also
public abstract void setBurstingLowerBound (int lowerBound)
Set the bursting subscription's lower bound.
public abstract void setBurstingUpperBound (int upperBound)
Set the bursting subscription's upper bound.
public abstract void setCustomMessage (String message)
Defines the custom message, which is any string that can attached to the actual content that will be delivered.
public abstract void setIsBursting (boolean isBursting)
Sets the boolean property indicating whether the subscription should be bursting
public abstract void setIsPushNotify (boolean isNotify)
Set if user's push notification or not
See Also
- #isPushNotifySeted()
public abstract void setIsUpdateBadge (boolean isUpdate)
Set if user update badge or not
See Also
public abstract 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 |
|---|