|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetNotificationsUsageCall
public class GetNotificationsUsageCall
Wrapper class of the GetNotificationsUsage call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
StartTime
- Specifies the start date and time for which notification information will be retrieved. StartTime is optional. If no StartTime is specified, the default value of 24 hours prior to the call time is used. If no StartTime is specified or if an invalid StartTime is specified, date range errors are returned in the response. For a StartTime to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the EndTime, and it cannot be later than the time of the call. If an invalid StartTime is specified, the default value is used.
EndTime
- Specifies the end date and time for which notification information will be retrieved. EndTime is optional. ItemID
- Specifies an item ID for which detailed notification information will be retrieved. ItemID is optional. If no ItemID is specified, the response will not include any individual notification details.
ReturnedStartTime
- Returns the start date and time for the notification information that is
returned by this call.
ReturnedEndTime
- Returns the end date and time for the notification information that is
returned by this call.
ReturnedNotificationDetailsArray
- List of notification objects representing the notifications sent to an
application for the given time period. It will only be returned if ItemID
was specified in the input request.
ReturnedMarkUpMarkDownHistory
- List of objects representing MarkUp or MarkDown history for a given appID
and for given StartTime and EndTime. This node will always be returned.
ReturnedNotificationStatistics
- Summary information about number of notifications that were successfully
delivered, queued, failed, connection attempts made, connection timeouts,
http errors for the given appID and given time period. By default, statistics
for only one day (Now-1day) is included. Maximum time duration allowed is 3 days
(Now-3days).
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetNotificationsUsageCall()
Constructor. |
|
GetNotificationsUsageCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
Calendar |
getEndTime()
Gets the GetNotificationsUsageRequestType.endTime. |
String |
getItemID()
Gets the GetNotificationsUsageRequestType.itemID. |
void |
getNotificationsUsage()
Retrieves usage information about platform notifications for a given application. |
Calendar |
getReturnedEndTime()
Valid after executing the API. |
MarkUpMarkDownHistoryType |
getReturnedMarkUpMarkDownHistory()
Valid after executing the API. |
NotificationDetailsArrayType |
getReturnedNotificationDetailsArray()
Valid after executing the API. |
NotificationStatisticsType |
getReturnedNotificationStatistics()
Valid after executing the API. |
Calendar |
getReturnedStartTime()
Valid after executing the API. |
Calendar |
getStartTime()
Gets the GetNotificationsUsageRequestType.startTime. |
void |
setEndTime(Calendar endTime)
Sets the GetNotificationsUsageRequestType.endTime. |
void |
setItemID(String itemID)
Sets the GetNotificationsUsageRequestType.itemID. |
void |
setStartTime(Calendar startTime)
Sets the GetNotificationsUsageRequestType.startTime. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetNotificationsUsageCall()
public GetNotificationsUsageCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getNotificationsUsage() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public Calendar getEndTime()
public void setEndTime(Calendar endTime)
endTime
- Calendarpublic String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic Calendar getStartTime()
public void setStartTime(Calendar startTime)
startTime
- Calendarpublic Calendar getReturnedEndTime()
public MarkUpMarkDownHistoryType getReturnedMarkUpMarkDownHistory()
public NotificationDetailsArrayType getReturnedNotificationDetailsArray()
public NotificationStatisticsType getReturnedNotificationStatistics()
public Calendar getReturnedStartTime()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.