C# 클래스 TradeMe.Api.Client.FavouriteMethods

The FavouriteMethods class contains the methods requried for making calls to the API related to Favourites.

파일 보기 프로젝트 열기: TradeMe/trade-me-api-wrapper 1 사용 예제들

공개 메소드들

메소드	설명
FavouriteMethods ( ConnectionMethods connect ) : System	Initializes a new instance of the FavouriteMethods class.
RemoveSavedFavorite ( string favoriteId, string type ) : System.Xml.Linq.XDocument	Performs the Favourites method: Deletes a saved search, category or seller from the currently authenticated user’s favourites. DELETE REQUIRES AUTHENTICATION.
RetrieveFavouriteCategories ( ) : SavedCategories	Performs the Favourites Method: Get Saved Categories. GET REQUIRES AUTHENTICATION.
RetrieveFavouriteSearches ( SavedSearchType filter ) : SavedSearches	Performs the Favourites Method: Get Saved Searches. GET REQURIES AUTHENTICATION.
RetrieveFavouriteSellers ( ) : SavedSellers	Performs the Favourites method: Get Saved Sellers. GET REQUIRES AUTHENTICATION.
SaveCategory ( SaveCategoryRequest saveCategory ) : System.Xml.Linq.XDocument	Performs the Favourites method: Save Category. POST Serializes the given SaveCategoryRequest into xml. REQUIRES AUTHENTICATION.
SaveSearch ( SaveSearchRequest saveSearch ) : System.Xml.Linq.XDocument	Performs the Favourites method: Save Search. POST Serializes the given SaveSearchRequest into xml. REQUIRES AUTHENTICATION.
SaveSeller ( SaveSellerRequest saveSeller ) : System.Xml.Linq.XDocument	Performs the Favourites method: Save Seller. POST Serializes the given SaveSellerRequest into xml. REQUIRES AUTHENTICATION.
UpdateSavedFavorite ( string favoriteId, string type, string frequency ) : System.Xml.Linq.XDocument	Performs the Favourites method: Modifies the email frequency for a saved favourite. POST REQUIRES AUTHENTICATION.

메소드 상세

FavouriteMethods() 공개 메소드

Initializes a new instance of the FavouriteMethods class.

public FavouriteMethods ( ConnectionMethods connect ) : System
connect	ConnectionMethods	A ConnectionMethods class used to make calls to the API
리턴	System

RemoveSavedFavorite() 공개 메소드

Performs the Favourites method: Deletes a saved search, category or seller from the currently authenticated user’s favourites. DELETE

REQUIRES AUTHENTICATION.

public RemoveSavedFavorite ( string favoriteId, string type ) : System.Xml.Linq.XDocument
favoriteId	string	The ID of the favourite.
type	string	The type of favourite (must be “Category”, “Search”, “AttributeSearch” or “Seller”).
리턴	System.Xml.Linq.XDocument

RetrieveFavouriteCategories() 공개 메소드

Performs the Favourites Method: Get Saved Categories. GET

REQUIRES AUTHENTICATION.

public RetrieveFavouriteCategories ( ) : SavedCategories
리턴	SavedCategories

RetrieveFavouriteSearches() 공개 메소드

Performs the Favourites Method: Get Saved Searches. GET

REQURIES AUTHENTICATION.

public RetrieveFavouriteSearches ( SavedSearchType filter ) : SavedSearches
filter	SavedSearchType
리턴	SavedSearches

RetrieveFavouriteSellers() 공개 메소드

Performs the Favourites method: Get Saved Sellers. GET

REQUIRES AUTHENTICATION.

public RetrieveFavouriteSellers ( ) : SavedSellers
리턴	SavedSellers

SaveCategory() 공개 메소드

Performs the Favourites method: Save Category. POST

Serializes the given SaveCategoryRequest into xml.

REQUIRES AUTHENTICATION.

public SaveCategory ( SaveCategoryRequest saveCategory ) : System.Xml.Linq.XDocument
saveCategory	SaveCategoryRequest	The object that will be serialized into xml and then sent in a POST message.
리턴	System.Xml.Linq.XDocument

SaveSearch() 공개 메소드

Performs the Favourites method: Save Search. POST

Serializes the given SaveSearchRequest into xml.

REQUIRES AUTHENTICATION.

public SaveSearch ( SaveSearchRequest saveSearch ) : System.Xml.Linq.XDocument
saveSearch	SaveSearchRequest	The object that will be serialized into xml and then sent in a POST message.
리턴	System.Xml.Linq.XDocument

SaveSeller() 공개 메소드

Performs the Favourites method: Save Seller. POST

Serializes the given SaveSellerRequest into xml.

REQUIRES AUTHENTICATION.

public SaveSeller ( SaveSellerRequest saveSeller ) : System.Xml.Linq.XDocument
saveSeller	SaveSellerRequest	The object that will be serialized into xml and then sent in a POST message.
리턴	System.Xml.Linq.XDocument

UpdateSavedFavorite() 공개 메소드

Performs the Favourites method: Modifies the email frequency for a saved favourite. POST

REQUIRES AUTHENTICATION.

public UpdateSavedFavorite ( string favoriteId, string type, string frequency ) : System.Xml.Linq.XDocument
favoriteId	string	The ID of the favourite.
type	string	The type of favourite (must be “Category”, “Search”, “AttributeSearch” or “Seller”).
frequency	string	The frequency that emails should be sent (must be “None”, “Daily”, “Every3Days” or “Weekly”).
리턴	System.Xml.Linq.XDocument