C# Class TradeMe.Api.Client.MembershipMethods

The MembershipMethods class contains the methods requried for making calls to the API related to memberships.
Show file Open project: TradeMe/trade-me-api-wrapper Class Usage Examples

Public Methods

Method Description
MemberFeedbackById ( string id, MemberFeedbackCriteria criteria ) : Feedback

Performs the Membership Method: Retrieve feedback for a member.

Creates a query string using the parameters provided - the criteria parameter can be null if it is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
MemberFeedbackByQueryString ( string query ) : Feedback

Performs the Membership Method: Retrieve feedback for a member

using the "query" string provided - should be the "Search/Member/{member_id}/Feedback.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
MemberFeedbackCountById ( string id ) : FeedbackCount

Performs the membership method: Retrieve member feedback summary (counts).

Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
MemberFeedbackCountByQueryString ( string query ) : FeedbackCount

Performs the membership method: Retrieve member feedback summary (counts) using the "query" string provided - should be the "Search/Member/{member_id}/FeedbackCount.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
MemberId ( string query ) : MemberId

Performs the Membership Method: Retrieve member ID

using the "query" string provided - should be the "Member/{member_nickname}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
MemberIdByNickname ( string nickname ) : MemberId

Performs the Membership Method: Retrieve member ID.

Creates a query string using the nickname parameter provided

DOES NOT REQUIRE AUTHENTICATION.
MemberListings ( string query ) : Listings

Performs the Membership Method: Retrieve a member’s listings. GET

using the "query" string provided - should be the "Member/{member_id}/Listings.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
MemberListingsById ( string id ) : Listings

Performs the Membership Method: Retrieve a member’s listings.

Creates a query string using the parameters provided.

DOES NOT REQUIRE AUTHENTICATION.
MemberProfileById ( string id ) : MemberProfile

Performs the membership method: Retrieve a member’s profile data. Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
MemberProfileByQueryString ( string query ) : MemberProfile

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
MembershipMethods ( ConnectionMethods connect ) : System

Initializes a new instance of the MembershipMethods class.

Private Methods

Method Description
FeedbackConnectionHelper ( string url ) : Feedback

A helper method for performing the http request for feedback requests.

DOES NOT REQUIRE AUTHENTICATION.
FeedbackCountConnectionHelper ( string url ) : FeedbackCount

A helper method for performing the http request for feedback count requests.
MemberIdConnectionHelper ( string url ) : MemberId

A helper method for performing the http request for MemberId requests.

DOES NOT REQUIRE AUTHENTICATION.
MemberProfileHelper ( string url ) : MemberProfile

A helper method for performing the http request for a member profile request.

Method Details

MemberFeedbackById() public method

Performs the Membership Method: Retrieve feedback for a member.

Creates a query string using the parameters provided - the criteria parameter can be null if it is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackById ( string id, MemberFeedbackCriteria criteria ) : Feedback
id string The members id.
criteria MemberFeedbackCriteria The criteria.
return Feedback

MemberFeedbackByQueryString() public method

Performs the Membership Method: Retrieve feedback for a member

using the "query" string provided - should be the "Search/Member/{member_id}/Feedback.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackByQueryString ( string query ) : Feedback
query string The query string that will be added to the base url and used to connect to the API with.
return Feedback

MemberFeedbackCountById() public method

Performs the membership method: Retrieve member feedback summary (counts).

Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackCountById ( string id ) : FeedbackCount
id string The members id.
return FeedbackCount

MemberFeedbackCountByQueryString() public method

Performs the membership method: Retrieve member feedback summary (counts) using the "query" string provided - should be the "Search/Member/{member_id}/FeedbackCount.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackCountByQueryString ( string query ) : FeedbackCount
query string The query string that will be added to the base url and used to connect to the API with.
return FeedbackCount

MemberId() public method

Performs the Membership Method: Retrieve member ID

using the "query" string provided - should be the "Member/{member_nickname}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberId ( string query ) : MemberId
query string The query string that will be added to the base url and used to connect to the API with.
return MemberId

MemberIdByNickname() public method

Performs the Membership Method: Retrieve member ID.

Creates a query string using the nickname parameter provided

DOES NOT REQUIRE AUTHENTICATION.
public MemberIdByNickname ( string nickname ) : MemberId
nickname string The members nickname.
return MemberId

MemberListings() public method

Performs the Membership Method: Retrieve a member’s listings. GET

using the "query" string provided - should be the "Member/{member_id}/Listings.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberListings ( string query ) : Listings
query string The query string that will be added to the base url and used to connect to the API with.
return Listings

MemberListingsById() public method

Performs the Membership Method: Retrieve a member’s listings.

Creates a query string using the parameters provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberListingsById ( string id ) : Listings
id string The members id.
return Listings

MemberProfileById() public method

Performs the membership method: Retrieve a member’s profile data. Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberProfileById ( string id ) : MemberProfile
id string The members id.
return MemberProfile

MemberProfileByQueryString() public method

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberProfileByQueryString ( string query ) : MemberProfile
query string The query string that will be added to the base url and used to connect to the API with.
return MemberProfile

MembershipMethods() public method

Initializes a new instance of the MembershipMethods class.
public MembershipMethods ( ConnectionMethods connect ) : System
connect ConnectionMethods A ConnectionMethods class used to make calls to the API
return System