|
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.RemoveFromWatchListCall
public class RemoveFromWatchListCall
Wrapper class of the RemoveFromWatchList 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.
ItemIDs
- The unique identifier of the item to be removed from the
user's Watch List. Multiple ItemID fields can be specified in the same request, but note that the RemoveAllItems field or VariationKey container cannot be specified if one or more ItemID fields are used.
RemoveAllItems
- If this field is included and set to true
, then all the items in the user's
Watch List are removed. Note that if the RemoveAllItems field is specified, one or more ItemID fields or the VariationKey cannot be used.
VariationKey
- This container is used if the user want to remove one or more product variations within a multiple-variation listing. Note that if the VariationKey container is used, one or more ItemID fields or the RemoveAllItems field cannot be used.
ReturnedWatchListCount
- The current number of items in the user's Watch List (considering that the items specified in the call request were successfully removed).
ReturnedWatchListMaximum
- The maximum number of items allowed in the user's Watch List. Currently this value is 300, and is the same for all sites and all users.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
RemoveFromWatchListCall()
Constructor. |
|
RemoveFromWatchListCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.String[] |
getItemIDs()
Gets the RemoveFromWatchListRequestType.itemIDs. |
java.lang.Boolean |
getRemoveAllItems()
Gets the RemoveFromWatchListRequestType.removeAllItems. |
int |
getReturnedWatchListCount()
Valid after executing the API. |
int |
getReturnedWatchListMaximum()
Valid after executing the API. |
VariationKeyType[] |
getVariationKey()
Gets the RemoveFromWatchListRequestType.variationKey. |
void |
removeFromWatchList()
The call enables a user to remove one or more items from their Watch List. |
void |
setItemIDs(java.lang.String[] itemIDs)
Sets the RemoveFromWatchListRequestType.itemIDs. |
void |
setRemoveAllItems(java.lang.Boolean removeAllItems)
Sets the RemoveFromWatchListRequestType.removeAllItems. |
void |
setVariationKey(VariationKeyType[] variationKey)
Sets the RemoveFromWatchListRequestType.variationKey. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RemoveFromWatchListCall()
public RemoveFromWatchListCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void removeFromWatchList() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.String[] getItemIDs()
public void setItemIDs(java.lang.String[] itemIDs)
itemIDs
- String[]public java.lang.Boolean getRemoveAllItems()
public void setRemoveAllItems(java.lang.Boolean removeAllItems)
removeAllItems
- Booleanpublic VariationKeyType[] getVariationKey()
public void setVariationKey(VariationKeyType[] variationKey)
variationKey
- VariationKeyType[]public int getReturnedWatchListCount()
public int getReturnedWatchListMaximum()
|
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.