C# Class Netsy.Helpers.EtsyUriBuilder

Class to build a Uri to the Etsy site

Mostrar archivo Open project: AnthonySteele/Netsy Class Usage Examples

Public Methods

Method	Description
ApiKey ( ) : EtsyUriBuilder	Append the Api key
Append ( IEnumerable values ) : EtsyUriBuilder	Append part of a url
Append ( string urlPart ) : EtsyUriBuilder	Append part of a url
DetailLevel ( DetailLevel detailLevel ) : EtsyUriBuilder	Append a detail level to the uri
Limit ( int limit ) : EtsyUriBuilder	Append an limit to the uri
Offset ( int offset ) : EtsyUriBuilder	Append an offset to the uri
OffsetLimit ( int offset, int limit ) : EtsyUriBuilder	Append an limit to the uri
OptionalParam ( string paramName, decimal paramValue ) : EtsyUriBuilder	Append a uri param to the uri, if the param has a value
OptionalParam ( string paramName, int paramValue ) : EtsyUriBuilder	Append a uri param to the uri, if the param has a value
Param ( string paramName, bool paramValue ) : EtsyUriBuilder	Append a uri param to the uri
Param ( string paramName, int paramValue ) : EtsyUriBuilder	Append a uri param to the uri
Param ( string paramName, string paramValue ) : EtsyUriBuilder	Append a uri param to the uri
Result ( ) : Uri	Generate the resulting Uri
Sort ( SortField sortField, SortOrder sortOrder ) : EtsyUriBuilder	Append a sort field and sort order to the uri
SortOrder ( SortOrder sortOrder ) : EtsyUriBuilder	Append a sort order to the uri
Start ( EtsyContext etsyContext ) : EtsyUriBuilder	Start the Uri with the base uri
Start ( EtsyContext etsyContext, string basePath ) : EtsyUriBuilder	Start the Uri with the base uri and a path under that
Start ( EtsyContext etsyContext, string basePath, EtsyColor color ) : EtsyUriBuilder	Start the Uri with the base uri and a path under that
Start ( EtsyContext etsyContext, string basePath, int id ) : EtsyUriBuilder	Start the Uri with the base uri and a path under that
Start ( EtsyContext etsyContext, string basePath, string id ) : EtsyUriBuilder	Start the Uri with the base uri and a path under that
ToString ( ) : string	Display for debug

Private Methods

Method	Description
EtsyUriBuilder ( EtsyContext etsyContext ) : System	Initializes a new instance of the etsyUriBuilder class

Method Details

ApiKey() public method

Append the Api key

public ApiKey ( ) : EtsyUriBuilder
return	EtsyUriBuilder

Append() public method

Append part of a url

public Append ( IEnumerable values ) : EtsyUriBuilder
values	IEnumerable	the values to append
return	EtsyUriBuilder

Append() public method

Append part of a url

public Append ( string urlPart ) : EtsyUriBuilder
urlPart	string	the partial url text to append
return	EtsyUriBuilder

DetailLevel() public method

Append a detail level to the uri

public DetailLevel ( DetailLevel detailLevel ) : EtsyUriBuilder
detailLevel	DetailLevel	the detail level
return	EtsyUriBuilder

Limit() public method

Append an limit to the uri

public Limit ( int limit ) : EtsyUriBuilder
limit	int	the result set limit
return	EtsyUriBuilder

Offset() public method

Append an offset to the uri

public Offset ( int offset ) : EtsyUriBuilder
offset	int	the result set offset
return	EtsyUriBuilder

OffsetLimit() public method

Append an limit to the uri

public OffsetLimit ( int offset, int limit ) : EtsyUriBuilder
offset	int	the result set offset
limit	int	the results limit
return	EtsyUriBuilder

OptionalParam() public method

Append a uri param to the uri, if the param has a value

public OptionalParam ( string paramName, decimal paramValue ) : EtsyUriBuilder
paramName	string	the param name
paramValue	decimal	the param value
return	EtsyUriBuilder

OptionalParam() public method

Append a uri param to the uri, if the param has a value

public OptionalParam ( string paramName, int paramValue ) : EtsyUriBuilder
paramName	string	the param name
paramValue	int	the param value
return	EtsyUriBuilder

Param() public method

Append a uri param to the uri

public Param ( string paramName, bool paramValue ) : EtsyUriBuilder
paramName	string	the param name
paramValue	bool	the param value
return	EtsyUriBuilder

Param() public method

Append a uri param to the uri

public Param ( string paramName, int paramValue ) : EtsyUriBuilder
paramName	string	the param name
paramValue	int	the param value
return	EtsyUriBuilder

Param() public method

Append a uri param to the uri

public Param ( string paramName, string paramValue ) : EtsyUriBuilder
paramName	string	the param name
paramValue	string	the param value
return	EtsyUriBuilder

Result() public method

Generate the resulting Uri

public Result ( ) : Uri
return	System.Uri

Sort() public method

Append a sort field and sort order to the uri

public Sort ( SortField sortField, SortOrder sortOrder ) : EtsyUriBuilder
sortField	SortField	the sort field
sortOrder	SortOrder	the sort order
return	EtsyUriBuilder

SortOrder() public method

Append a sort order to the uri

public SortOrder ( SortOrder sortOrder ) : EtsyUriBuilder
sortOrder	SortOrder	the sort order
return	EtsyUriBuilder

Start() public static method

Start the Uri with the base uri

public static Start ( EtsyContext etsyContext ) : EtsyUriBuilder
etsyContext	Netsy.DataModel.EtsyContext	the etsy context
return	EtsyUriBuilder

Start() public static method

Start the Uri with the base uri and a path under that

public static Start ( EtsyContext etsyContext, string basePath ) : EtsyUriBuilder
etsyContext	Netsy.DataModel.EtsyContext	the etsy context
basePath	string	the path on the base uri
return	EtsyUriBuilder

Start() public static method

Start the Uri with the base uri and a path under that

public static Start ( EtsyContext etsyContext, string basePath, EtsyColor color ) : EtsyUriBuilder
etsyContext	Netsy.DataModel.EtsyContext	the etsy context
basePath	string	the path on the base uri
color	Netsy.DataModel.EtsyColor	the color to append
return	EtsyUriBuilder

Start() public static method

Start the Uri with the base uri and a path under that

public static Start ( EtsyContext etsyContext, string basePath, int id ) : EtsyUriBuilder
etsyContext	Netsy.DataModel.EtsyContext	the etsy context
basePath	string	the path on the base uri
id	int	the item id to append
return	EtsyUriBuilder

Start() public static method

Start the Uri with the base uri and a path under that

public static Start ( EtsyContext etsyContext, string basePath, string id ) : EtsyUriBuilder
etsyContext	Netsy.DataModel.EtsyContext	the etsy context
basePath	string	the path on the base uri
id	string	the item id to append
return	EtsyUriBuilder

ToString() public method

Display for debug

public ToString ( ) : string
return	string