C# Class ZipRecruiter.JobAlertsAPI

API Object used by Resource classes which API Call specific data and preferences. Includes a simple interface to instantiate Resource objects, useful for creating chained calls.
Exibir arquivo Open project: ZipRecruiter/JobAlerts Class Usage Examples

Public Methods

Method Description
JobAlertsAPI ( ) : System

Initializes a new instance of the ZipRecruiter.API class. Initialized the internal APIKey using the GlobalAPIKey.
JobAlertsAPI ( String apiKey ) : System

Initializes a new instance of the ZipRecruiter.API class.
Resource ( String endpoint ) : dynamic

Uses the given resource endpoint to return the propper ApiResource class to invoke calls on.

Protected Methods

Method Description
DeserializeResults ( Stream responseData, Type serializerType ) : dynamic

Deserializes the results of the API call into a usable native type.

Private Methods

Method Description
MakeRequest ( WebRequest request, Type serializerType, Byte body ) : dynamic

Augments the given WebRequest object to match the needs of the API and returns a deserialized native type.
MakeRequest ( WebRequest request, Type serializerType, String body = "" ) : dynamic

Augments the given WebRequest object to match the needs of the API and returns a deserialized native type.

Method Details

DeserializeResults() protected method

Deserializes the results of the API call into a usable native type.
protected DeserializeResults ( Stream responseData, Type serializerType ) : dynamic
responseData Stream Raw response data from the server
serializerType System.Type The target deserialization type.
return dynamic

JobAlertsAPI() public method

Initializes a new instance of the ZipRecruiter.API class. Initialized the internal APIKey using the GlobalAPIKey.
public JobAlertsAPI ( ) : System
return System

JobAlertsAPI() public method

Initializes a new instance of the ZipRecruiter.API class.
public JobAlertsAPI ( String apiKey ) : System
apiKey String The desired Private ZipRecruiter API key
return System

Resource() public method

Uses the given resource endpoint to return the propper ApiResource class to invoke calls on.
public Resource ( String endpoint ) : dynamic
endpoint String The desired API Resource endpoint
return dynamic