| com.microstrategy.web.beans.EnumSubscriptionBeanEvents |
This interface defines all the event IDs and event arguments for the
SubscriptionBean.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ITEM_SEPARATOR | ||||||||||
| String | RECIPIENTS_SEPARATOR | ||||||||||
| String | SIMPLE_SEPARATOR_COMMA | ||||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID | Argument specifying the address ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE | When set to 1, new subscriptions are created with
addresses SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES | argument specifying a list of addresses. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_BCC | Address values created on the fly for BCC field | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_CC | Address values created on the fly for CC field | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_TO | Address values created on the fly for To field | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALERT_CONTENT_DSS_ID | DSS ID of the report or document that is sent in the alert | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALERT_CONTENT_TYPE | Type, from EnumDSSXMLObjectTypes, of the report or document. |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALERT_SEND_DIFFERENT_CONTENT | Argument that indicates whether to send a different report or document for the alert | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS | Indicates the boolean to allow changing delivery settings. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION | Indicates the boolean to allow changing personalization. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE | Indicates the boolean to allow unsubscribing | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BADGE_METRIC_ID | Argument to specify the metric used for update badge | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURST | Space Delimiter for Filename saved for scheduled file subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_LOWERBOUND | Argument to specify the bursting segment lower bound | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_UPPERBOUND | Argument to specify the bursting segment upper bound | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURST_ADDRESS_ID | Email bursting - Address id include Attribute Id and Form Id that concatenated with delimiter '~' | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURST_DEVICE_ID | Email bursting - Device Id | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_BURST_SUB_FOLDER | File bursting - sub folder | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME | Indicates compression file name. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_ID | contact id | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY | Argument to specify the contact security for each contact group member | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE |
This constant is deprecated.
replaced by SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_ALL_PAGES |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_ALL_PAGES | Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1"). | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES | Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID | Argument specifying the content object ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE | Integer argument to specify a content's subtype | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE | Argument specifying the content object type
(see EnumDSSXMLObjectTypes). |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_COPIES | Number of copies for in a scheduled print subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE | Message to be saved along with the email subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_DATA_LINK_HISTORY_LIST | Argument that contains the SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK, SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA
and SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX arguments concatenated using a "," separator. |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER | delimiter for bulk export format | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID | Argument specifying the ID of the device. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE | Denotes the edit mode. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_DESTINATION_TYPE | destination type | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT | Argument specifying the email subject. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS | Argument to specific whether we need to delivery all layouts when the subscription is run | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE | Indicates the expiration date of the subscription | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME | File name saved for scheduled file subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME_SPACE_DELIMITER | Space Delimiter for Filename saved for scheduled file subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE | The serialized state of the delivery format. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA | Indicates if the data needs to be included in the subscription | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK | Indicates if we need to include a link to the content | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_TYPE | Argument for setting the include/destination type for email subscriptions. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_BURSTING | Argument to indicate if it's a bursting subscription | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_COLLATED | Whether printed pages should be collated. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION | Argument for the overwrite older version of the History List message. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_PERSONAL_VIEW_PUBLIC | Argument to control whether a personal view subscription is private or public. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_PORTRAIT | Whether printing is in portrait or landscape mode. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_PUSH_NOTIFY | Argument to control will send push notification or not | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_IS_UPDATE_BADGE | Argument to control Is update badge or not | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY | Location key for file and print scheduled subscriptions. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID | Argument specifying the message ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_APP_DEVICE_ID | Argument for the mobile device ID | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_CLIENT_TYPE | Argument to specify the client type for mobile subscriptions (from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType) | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID | Subscription notification is sent to this existing address. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE | When set to 1 it indicates that the new address
SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be
used for the new subscription, while 0 indicates an existing address
SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should
be used instead. |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE | Subscription notification is sent to this new address. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID | Notification device ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY | When set to 0, notification is turned off, otherwise its turned on. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID | Origin message ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML | Origin short answer XML. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER | user defined delimiter for bulk export format | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER | Plain element prompt answer. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER | Plain objects prompt answer. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER | Plain value prompt answer. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_PRINT_ALL | Whether to print all pages. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE | Indicates whether to protect the zip file. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END | Page number to print to
(also see SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START). |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START | Page number to begin printing
(also see SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END). |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW | Argument specifying whether send now should be set. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX | Indicates if the content should be sent to History List | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID | Argument specifying the state ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID | Argument specifying the subscription ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME | Argument for specifying the name of the subscription | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID | Argument specifying the trigger ID. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_USE_DATASET_CACHE | Used to take "use valid dataset caches" value for RWD | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE | Argument to specify whether the subscription should be saved with an expiration date or not. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE | Specifies the view mode for the report
EnumWebReportViewMode. |
|||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS | Indicates whether the format should be zipped. | |||||||||
| int | SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD | Indicates the password if the file needs to be compressed | |||||||||
| int | SUBSCRIPTION_EVENT_CANCEL | Calls cancel on the SubscriptionBean. |
|||||||||
| int | SUBSCRIPTION_EVENT_DELETE | Deletes the current subscription | |||||||||
| int | SUBSCRIPTION_EVENT_INCLUDE_PERSONALIZATION_EDITING | include personalization in edit mode. | |||||||||
| int | SUBSCRIPTION_EVENT_REMOVE_RECIPIENT | remove a recipient using contact ID or/and address ID. | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE | saves the current SUBSCRIPTION. | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_CACHE | Event to save the cache subscription | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_FILE | Event to save a file subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_FTP | Event to save a FTP subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_HISTORY_LIST | Event to save the history list subscription | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_MOBILE | Event to save a mobile subscrition | |||||||||
| int | SUBSCRIPTION_EVENT_SAVE_PERSONAL_VIEW | ||||||||||
| int | SUBSCRIPTION_EVENT_SAVE_PRINT | Event to save a print subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SET_ALERTING_CONTENT | For an alerting subscription, you can send a different report or document. | |||||||||
| int | SUBSCRIPTION_EVENT_SET_CACHE_PROPERTIES | Event to set properties for a cache subscription | |||||||||
| int | SUBSCRIPTION_EVENT_SET_EMAIL_PROPERTIES | Initializes the state of the SubscriptionBean for email subscriptions. |
|||||||||
| int | SUBSCRIPTION_EVENT_SET_FILE_PROPERTIES | Properties associated with a file subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SET_FTP_PROPERTIES | Properties associated with a FTP subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SET_HISTORY_LIST_PROPERTIES | Event to set properties for a history list subscription | |||||||||
| int | SUBSCRIPTION_EVENT_SET_MOBILE_PROPERTIES | Event to set properties for a history list subscription | |||||||||
| int | SUBSCRIPTION_EVENT_SET_PERSONAL_VIEW_PROPERTIES | ||||||||||
| int | SUBSCRIPTION_EVENT_SET_PRINT_PROPERTIES | Properties associated with a print subscription. | |||||||||
| int | SUBSCRIPTION_EVENT_SET_STATE | This constant is deprecated. use SUBSCRIPTION_EVENT_SET_EMAIL_PROPERTIES instead | |||||||||
| String | UNIT_SEPARATOR | ||||||||||
Argument specifying the address ID.
As of MicroStrategy Web 8.0.1, setting this argument will
clear all other addresses in getAddresses().
When set to 1, new subscriptions are created with
addresses SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise,
on a 0, existing address SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID
is used instead.
If a value is not specified for this argument, then both
SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES
and SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used
argument specifying a list of addresses.
Address values created on the fly for BCC field
Address values created on the fly for CC field
Address values created on the fly for To field
DSS ID of the report or document that is sent in the alert
Type, from EnumDSSXMLObjectTypes, of the report or document.
Argument that indicates whether to send a different report or document for the alert
Indicates the boolean to allow changing delivery settings.
Indicates the boolean to allow changing personalization.
Indicates the boolean to allow unsubscribing
Argument to specify the metric used for update badge
Space Delimiter for Filename saved for scheduled file subscription.
Argument to specify the bursting segment lower bound
Argument to specify the bursting segment upper bound
Email bursting - Address id include Attribute Id and Form Id that concatenated with delimiter '~'
Email bursting - Device Id
File bursting - sub folder
Indicates compression file name.
contact id
Argument to specify the contact security for each contact group member
This constant is deprecated.
replaced by SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_ALL_PAGES
Denotes whether the only the current page, or all pages is applied to the subscription.
Denotes whether the only the current page (value of "0"), or all pages is applied to the subscription (value of "1").
Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.
Argument specifying the content object ID.
Integer argument to specify a content's subtype
Argument specifying the content object type
(see EnumDSSXMLObjectTypes).
Number of copies for in a scheduled print subscription.
Message to be saved along with the email subscription.
Argument that contains the SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK, SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA
and SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX arguments concatenated using a "," separator. This is useful
if the event wants to combine the above arguments into a set of options and send them all in using 1 argument.
delimiter for bulk export format
Argument specifying the ID of the device.
Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes
destination type
Argument specifying the email subject.
Argument to specific whether we need to delivery all layouts when the subscription is run
Indicates the expiration date of the subscription
File name saved for scheduled file subscription.
Space Delimiter for Filename saved for scheduled file subscription.
The serialized state of the delivery format.
Indicates if the data needs to be included in the subscription
Indicates if we need to include a link to the content
Argument for setting the include/destination type for email subscriptions. From EnumDSSXMLNCSEmailDestinationType
Argument to indicate if it's a bursting subscription
Whether printed pages should be collated.
Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.
Argument to control whether a personal view subscription is private or public.
Whether printing is in portrait or landscape mode.
Argument to control will send push notification or not
Argument to control Is update badge or not
Location key for file and print scheduled subscriptions.
Argument specifying the message ID.
Argument for the mobile device ID
Argument to specify the client type for mobile subscriptions (from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType)
Subscription notification is sent to this existing address.
When set to 1 it indicates that the new address
SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be
used for the new subscription, while 0 indicates an existing address
SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should
be used instead.
A value of 2 indicates notification be sent to default email addresses of child recipients.
Subscription notification is sent to this new address.
Notification device ID.
When set to 0, notification is turned off, otherwise its turned on.
Origin message ID.
Origin short answer XML.
user defined delimiter for bulk export format
Plain element prompt answer.
Plain objects prompt answer.
Plain value prompt answer.
Whether to print all pages.
Indicates whether to protect the zip file.
Page number to print to
(also see SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START).
Page number to begin printing
(also see SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END).
Argument specifying whether send now should be set.
Indicates if the content should be sent to History List
Argument specifying the state ID.
Argument specifying the subscription ID.
Argument for specifying the name of the subscription
Argument specifying the trigger ID.
Used to take "use valid dataset caches" value for RWD
Argument to specify whether the subscription should be saved with an expiration date or not.
Specifies the view mode for the report
EnumWebReportViewMode.
Indicates whether the format should be zipped.
Indicates the password if the file needs to be compressed
Calls cancel on the SubscriptionBean.
Deletes the current subscription
include personalization in edit mode.
remove a recipient using contact ID or/and address ID.
saves the current SUBSCRIPTION. This accepts all arguments that are accepted by
SUBSCRIPTION_EVENT_SET_STATE.
Event to save the cache subscription
Event to save a file subscription.
Event to save a FTP subscription.
Event to save the history list subscription
Event to save a mobile subscrition
Event to save a print subscription.
For an alerting subscription, you can send a different report or document. This event will set the alerting content on the subscription.
Event to set properties for a cache subscription
Initializes the state of the SubscriptionBean for email subscriptions.
The content parameters are used only if the content is not already set.
If the address input type is specified as 0, then the address values are ignored
and only the addressID is used
Properties associated with a file subscription.
Properties associated with a FTP subscription.
Event to set properties for a history list subscription
Event to set properties for a history list subscription
Properties associated with a print subscription.
This constant is deprecated.
use SUBSCRIPTION_EVENT_SET_EMAIL_PROPERTIES instead