Changes since
the last release

com.ebay.sdk.call
Class GetMessagePreferencesCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetMessagePreferencesCall

public class GetMessagePreferencesCall
extends ApiCall

Wrapper class of the GetMessagePreferences 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.


Input property: SellerID - The eBay user ID of the seller to retrieve ASQ subjects for. A user can retrieve their own ASQ subjects or those of another eBay user with a seller account.
Input property: IncludeASQPreferences - This field must be included and set to true to retrieve the ASQ subjects for the specified eBay user.
Output property: ReturnedASQPreferences - Returns a seller's ASQ subjects, each in its own Subject node. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values. Returned if IncludeASQPreferences = true was specified in the request.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetMessagePreferencesCall()
          Constructor.
GetMessagePreferencesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Boolean getIncludeASQPreferences()
          Gets the GetMessagePreferencesRequestType.includeASQPreferences.
 ASQPreferencesType getMessagePreferences()
          Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject field.
 ASQPreferencesType getReturnedASQPreferences()
          Valid after executing the API.
 java.lang.String getSellerID()
          Gets the GetMessagePreferencesRequestType.sellerID.
 void setIncludeASQPreferences(java.lang.Boolean includeASQPreferences)
          Sets the GetMessagePreferencesRequestType.includeASQPreferences.
 void setSellerID(java.lang.String sellerID)
          Sets the GetMessagePreferencesRequestType.sellerID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetMessagePreferencesCall

public GetMessagePreferencesCall()
Constructor.


GetMessagePreferencesCall

public GetMessagePreferencesCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getMessagePreferences

public ASQPreferencesType getMessagePreferences()
                                         throws ApiException,
                                                SdkException,
                                                java.lang.Exception
Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject field.

Returns:
The ASQPreferencesType object.
Throws:
ApiException
SdkException
java.lang.Exception

getIncludeASQPreferences

public java.lang.Boolean getIncludeASQPreferences()
Gets the GetMessagePreferencesRequestType.includeASQPreferences.

Returns:
Boolean

setIncludeASQPreferences

public void setIncludeASQPreferences(java.lang.Boolean includeASQPreferences)
Sets the GetMessagePreferencesRequestType.includeASQPreferences.

Parameters:
includeASQPreferences - Boolean

getSellerID

public java.lang.String getSellerID()
Gets the GetMessagePreferencesRequestType.sellerID.

Returns:
String

setSellerID

public void setSellerID(java.lang.String sellerID)
Sets the GetMessagePreferencesRequestType.sellerID.

Parameters:
sellerID - String

getReturnedASQPreferences

public ASQPreferencesType getReturnedASQPreferences()
Valid after executing the API. Gets the returned GetMessagePreferencesResponseType.returnedASQPreferences.

Returns:
ASQPreferencesType

Changes since
the last release

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.