Trading_ApplicationDeliveryPreferencesType Class Reference
| Inherits from | NSObject |
| Conforms to | PicoBindable |
| Declared in | Trading_ApplicationDeliveryPreferencesType.h Trading_ApplicationDeliveryPreferencesType.m |
Overview
Specifies preferences about how notifications are delivered to an application.
@ingroup EBayAPIInterface
Tasks
-
applicationURLThe URL to which eBay delivers all notifications sent to the application. For
property
delivery to a server, the URL begins with http:// or https:// and must be well
formed. Use a URL that is functional at the time of the call. For delivery to
an email address, the URL begins with mailto:// and specifies a valid email
address. -
applicationEnableEnables or disables notifications and alerts. If you disable notifications, the
property
application will not receive them, but its notification preferences are
preserved. -
alertEmailThe email address to which eBay sends all application markup and markdown event
property
notifications. When setting the email address, input must be in the format
mailto://youremailaddress@yoursite.com. Enable these alerts using the
AlertEnable field. -
alertEnableFor SetNotificationPreferences: include and set AlertEnable to
property
‘Enable’ to receive application markup and markdown alerts, or set to ‘Disable’ to
disable the alerts. If not included, the AlertEnable defaults to
its current value.
For GetNotificationPreferences: this field’s value indicates
whether application markup and markdown alerts are enabled or disabled. -
notificationPayloadTypeIf this field is specified, the value must be eBLSchemaSOAP.
property -
deviceTypeThe means of receipt of notification. In most cases, it is Platform (typical API
property
calls and web interaction), so this is the default, if not specified. For
wireless applications, use SMS. Do not test Client Alerts in production if you
are currently using Platform Notifications. -
payloadVersionUse this field to specify the API version for all notifications for the calling
property
application. If you do not specify PayloadVersion in
SetNotificationPreferences, the API version for notifications will be based on
the API version specified in your SetNotificationPreferences call. -
deliveryURLDetailsDefines settings for notification URLs (including the URL name in DeliveryURLName). You
property
define settings for up to 25 notification URLs (including the URL name in
DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with
notification URLs by using the token in a SetNotificationPreferences request that
specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use
comma-separated format to specify multiple URL names in
SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these
URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable. -
any(public property)
property
Properties
alertEmail
The email address to which eBay sends all application markup and markdown event
notifications. When setting the email address, input must be in the format
mailto://youremailaddress@yoursite.com. Enable these alerts using the
AlertEnable field.
@property (nonatomic, retain) NSString *alertEmailDiscussion
The email address to which eBay sends all application markup and markdown event
notifications. When setting the email address, input must be in the format
mailto://youremailaddress@yoursite.com. Enable these alerts using the
AlertEnable field.
type : NSString, wrapper for primitive string
Declared In
Trading_ApplicationDeliveryPreferencesType.halertEnable
For SetNotificationPreferences: include and set AlertEnable to
‘Enable’ to receive application markup and markdown alerts, or set to ‘Disable’ to
disable the alerts. If not included, the AlertEnable defaults to
its current value.
For GetNotificationPreferences: this field’s value indicates
whether application markup and markdown alerts are enabled or disabled.
@property (nonatomic, retain) NSString *alertEnableDiscussion
For SetNotificationPreferences: include and set AlertEnable to
‘Enable’ to receive application markup and markdown alerts, or set to ‘Disable’ to
disable the alerts. If not included, the AlertEnable defaults to
its current value.
For GetNotificationPreferences: this field’s value indicates
whether application markup and markdown alerts are enabled or disabled.
type: string constant in Trading_EnableCodeType.h
Declared In
Trading_ApplicationDeliveryPreferencesType.hany
(public property)
@property (nonatomic, retain) NSMutableArray *anyDiscussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_ApplicationDeliveryPreferencesType.happlicationEnable
Enables or disables notifications and alerts. If you disable notifications, the
application will not receive them, but its notification preferences are
preserved.
@property (nonatomic, retain) NSString *applicationEnableDiscussion
Enables or disables notifications and alerts. If you disable notifications, the
application will not receive them, but its notification preferences are
preserved.
type: string constant in Trading_EnableCodeType.h
Declared In
Trading_ApplicationDeliveryPreferencesType.happlicationURL
The URL to which eBay delivers all notifications sent to the application. For
delivery to a server, the URL begins with http:// or https:// and must be well
formed. Use a URL that is functional at the time of the call. For delivery to
an email address, the URL begins with mailto:// and specifies a valid email
address.
@property (nonatomic, retain) NSString *applicationURLDiscussion
The URL to which eBay delivers all notifications sent to the application. For
delivery to a server, the URL begins with http:// or https:// and must be well
formed. Use a URL that is functional at the time of the call. For delivery to
an email address, the URL begins with mailto:// and specifies a valid email
address.
type : NSString, wrapper for primitive string
Declared In
Trading_ApplicationDeliveryPreferencesType.hdeliveryURLDetails
Defines settings for notification URLs (including the URL name in DeliveryURLName). You
define settings for up to 25 notification URLs (including the URL name in
DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with
notification URLs by using the token in a SetNotificationPreferences request that
specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use
comma-separated format to specify multiple URL names in
SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these
URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable.
@property (nonatomic, retain) NSMutableArray *deliveryURLDetailsDiscussion
Defines settings for notification URLs (including the URL name in DeliveryURLName). You
define settings for up to 25 notification URLs (including the URL name in
DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with
notification URLs by using the token in a SetNotificationPreferences request that
specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use
comma-separated format to specify multiple URL names in
SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these
URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable.
entry type : class Trading_DeliveryURLDetailType
Declared In
Trading_ApplicationDeliveryPreferencesType.hdeviceType
The means of receipt of notification. In most cases, it is Platform (typical API
calls and web interaction), so this is the default, if not specified. For
wireless applications, use SMS. Do not test Client Alerts in production if you
are currently using Platform Notifications.
@property (nonatomic, retain) NSString *deviceTypeDiscussion
The means of receipt of notification. In most cases, it is Platform (typical API
calls and web interaction), so this is the default, if not specified. For
wireless applications, use SMS. Do not test Client Alerts in production if you
are currently using Platform Notifications.
type: string constant in Trading_DeviceTypeCodeType.h
Declared In
Trading_ApplicationDeliveryPreferencesType.hnotificationPayloadType
If this field is specified, the value must be eBLSchemaSOAP.
@property (nonatomic, retain) NSString *notificationPayloadTypeDiscussion
If this field is specified, the value must be eBLSchemaSOAP.
type: string constant in Trading_NotificationPayloadTypeCodeType.h
Declared In
Trading_ApplicationDeliveryPreferencesType.hpayloadVersion
Use this field to specify the API version for all notifications for the calling
application. If you do not specify PayloadVersion in
SetNotificationPreferences, the API version for notifications will be based on
the API version specified in your SetNotificationPreferences call.
@property (nonatomic, retain) NSString *payloadVersionDiscussion
Use this field to specify the API version for all notifications for the calling
application. If you do not specify PayloadVersion in
SetNotificationPreferences, the API version for notifications will be based on
the API version specified in your SetNotificationPreferences call.
type : NSString, wrapper for primitive string
Declared In
Trading_ApplicationDeliveryPreferencesType.h