|
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.GetSellerEventsCall
public class GetSellerEventsCall
Wrapper class of the GetSellerEvents 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.
UserID
- eBay user ID for the seller whose events are to be returned.
If not specified, retrieves events for the user identified by
the authentication token passed in the request.
StartTimeFilter
- Helper wrapper to set GetSellerEventsRequestType StartTimeFrom, StartTimeTo:
TimeFrom sets GetSellerEventsRequestType.StartTimeFrom:
Describes the earliest (oldest) time to use in a time range filter based
on item start time. Must be specified if StartTimeTo is specified.
EndTimeFilter
- Helper wrapper to set GetSellerEventsRequestType EndTimeFrom, EndTimeTo:
TimeFrom sets GetSellerEventsRequestType.EndTimeFrom:
Describes the earliest (oldest) date to use in a time range filter based
on item end time. Must be specified if EndTimeTo is specified.
ModTimeFilter
- Helper wrapper to set GetSellerEventsRequestType ModTimeFrom, ModTimeTo:
TimeFrom sets GetSellerEventsRequestType.ModTimeFrom:
Describes the earliest (oldest) date to use in a time range filter based
on item modification time. Must be specified if ModTimeTo is specified. Either
the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.
If you do not specify the corresponding To filter,
it is set to the time you make the call.IncludeNewItem
- If true, response includes only items that have been modified
within the ModTime range. If false, response includes all items.
IncludeWatchCount
- The seller can include this field and set its value to true
if that seller wants to see how many prospective bidders/buyers currently have an item added to their Watch Lists. The Watch count is returned in the WatchCount field for each item in the response.
IncludeVariationSpecifics
- Specifies whether to force the response to include
variation specifics for multiple-variation listings. HideVariations
- Specifies whether to force the response to hide
variation details for multiple-variation listings.TimeTo
- Indicates the latest (most recent) date for any date-based filtering specified as
input. Specifically, this field contains the value you specified in the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time.
ReturnedSellerEvents
- Collection of items whose last modified time matches
the filters specified in the request.
Returns empty if no items were modified within the
time range of the request.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetSellerEventsCall()
Constructor. |
|
GetSellerEventsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
TimeFilter |
getEndTimeFilter()
Gets the GetSellerEventsRequestType.endTimeFilter. |
java.lang.Boolean |
getHideVariations()
Gets the GetSellerEventsRequestType.hideVariations. |
boolean |
getIncludeNewItem()
Gets the GetSellerEventsRequestType.includeNewItem. |
java.lang.Boolean |
getIncludeVariationSpecifics()
Gets the GetSellerEventsRequestType.includeVariationSpecifics. |
java.lang.Boolean |
getIncludeWatchCount()
Gets the GetSellerEventsRequestType.includeWatchCount. |
TimeFilter |
getModTimeFilter()
Gets the GetSellerEventsRequestType.modTimeFilter. |
ItemType[] |
getReturnedSellerEvents()
Valid after executing the API. |
ItemType[] |
getSellerEvents()
Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings. |
TimeFilter |
getStartTimeFilter()
Gets the GetSellerEventsRequestType.startTimeFilter. |
java.util.Calendar |
getTimeTo()
Valid after executing the API. |
java.lang.String |
getUserID()
Gets the GetSellerEventsRequestType.userID. |
void |
setEndTimeFilter(TimeFilter endTimeFilter)
Sets the GetSellerEventsRequestType.endTimeFilter. |
void |
setHideVariations(java.lang.Boolean hideVariations)
Sets the GetSellerEventsRequestType.hideVariations. |
void |
setIncludeNewItem(boolean includeNewItem)
Sets the GetSellerEventsRequestType.includeNewItem. |
void |
setIncludeVariationSpecifics(java.lang.Boolean includeVariationSpecifics)
Sets the GetSellerEventsRequestType.includeVariationSpecifics. |
void |
setIncludeWatchCount(java.lang.Boolean includeWatchCount)
Sets the GetSellerEventsRequestType.includeWatchCount. |
void |
setModTimeFilter(TimeFilter modTimeFilter)
Sets the GetSellerEventsRequestType.modTimeFilter. |
void |
setStartTimeFilter(TimeFilter startTimeFilter)
Sets the GetSellerEventsRequestType.startTimeFilter. |
void |
setUserID(java.lang.String userID)
Sets the GetSellerEventsRequestType.userID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetSellerEventsCall()
public GetSellerEventsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public ItemType[] getSellerEvents() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public TimeFilter getEndTimeFilter()
public void setEndTimeFilter(TimeFilter endTimeFilter)
endTimeFilter
- TimeFilterpublic java.lang.Boolean getHideVariations()
public void setHideVariations(java.lang.Boolean hideVariations)
hideVariations
- Booleanpublic boolean getIncludeNewItem()
public void setIncludeNewItem(boolean includeNewItem)
includeNewItem
- booleanpublic java.lang.Boolean getIncludeVariationSpecifics()
public void setIncludeVariationSpecifics(java.lang.Boolean includeVariationSpecifics)
includeVariationSpecifics
- Booleanpublic java.lang.Boolean getIncludeWatchCount()
public void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
includeWatchCount
- Booleanpublic TimeFilter getModTimeFilter()
public void setModTimeFilter(TimeFilter modTimeFilter)
modTimeFilter
- TimeFilterpublic TimeFilter getStartTimeFilter()
public void setStartTimeFilter(TimeFilter startTimeFilter)
startTimeFilter
- TimeFilterpublic java.lang.String getUserID()
public void setUserID(java.lang.String userID)
userID
- Stringpublic ItemType[] getReturnedSellerEvents()
public java.util.Calendar getTimeTo()
|
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.