C# Class ZipRecruiter.Resource.APIResource

Base class for API resources. Not to be instantiated on its own.
Inheritance: ICloneable
Afficher le fichier Open project: ZipRecruiter/JobAlerts

Protected Properties

Свойство Type Description
batchID String
endpoint String
handle JobAlertsAPI
jobSearchID String
operatingMode APIResourceMode
subscriberID String

Méthodes publiques

Méthode Description
APIResource ( JobAlertsAPI handle ) : System
AddParameter ( String key, String value ) : APIResource

Adds a single key/value pair to the parameter dictionary.

AddParameters ( String>.Dictionary parameters ) : APIResource

Adds to the parameters dictionary.

Call ( ) : dynamic

Performs the API call which has been constructed.

ClearParameters ( ) : APIResource

Clears the Parameters dictionary.

Clone ( ) : Object

Deep copy this instance.

Deactivate ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic

Attempts to deactivate a record using the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given.

Query ( String>.Dictionary parameters, String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic

Attempts to search for records matching the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given. This methods has a "parameters" dictionary argument and the results will be augmented by its contents.

Query ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic

Attempts to search for records matching the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given. This methods lacks a "parameters" dictionary argument and as a result will grab all records for the specified endpoint.

RemoveParameter ( String key ) : APIResource

Removes the a single parameter from the parameter dictionary.

Retrieve ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic

Attempts to retrieve a record using the given parameters using a GET. Arguments are optional and context sensitive. An exception will be thrown if an invalid parameter is given.

Submit ( String>.Dictionary parameters, String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic

Attempts to retrieve a record using the given parameters using a POST. Arguments except the "parameters" Dictionary are optional and context sensitive. An exception will be thrown if an invalid parameter is given.

Méthodes protégées

Méthode Description
BuildRequestUrl ( ) : String

Builds the request URL.

DetermineSerializationType ( ) : Type

Uses the class's instance variables to determine the propper Type to be given to the XMLDeseralizer when invoked by the Call method.

Method Details

APIResource() public méthode

public APIResource ( JobAlertsAPI handle ) : System
handle JobAlertsAPI
Résultat System

AddParameter() public méthode

Adds a single key/value pair to the parameter dictionary.
public AddParameter ( String key, String value ) : APIResource
key String Parameter Key.
value String Parameter Value.
Résultat APIResource

AddParameters() public méthode

Adds to the parameters dictionary.
public AddParameters ( String>.Dictionary parameters ) : APIResource
parameters String>.Dictionary Request parameters.
Résultat APIResource

BuildRequestUrl() protected méthode

Builds the request URL.
protected BuildRequestUrl ( ) : String
Résultat String

Call() public méthode

Performs the API call which has been constructed.
public Call ( ) : dynamic
Résultat dynamic

ClearParameters() public méthode

Clears the Parameters dictionary.
public ClearParameters ( ) : APIResource
Résultat APIResource

Clone() public méthode

Deep copy this instance.
public Clone ( ) : Object
Résultat Object

Deactivate() public méthode

Attempts to deactivate a record using the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given.
public Deactivate ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic
subscriberID String Subscriber I.
jobSearchID String Job search I.
batchID String Batch I.
Résultat dynamic

DetermineSerializationType() protected méthode

Uses the class's instance variables to determine the propper Type to be given to the XMLDeseralizer when invoked by the Call method.
protected DetermineSerializationType ( ) : Type
Résultat System.Type

Query() public méthode

Attempts to search for records matching the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given. This methods has a "parameters" dictionary argument and the results will be augmented by its contents.
public Query ( String>.Dictionary parameters, String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic
parameters String>.Dictionary Parameters.
subscriberID String Subscriber I.
jobSearchID String Job search I.
batchID String Batch I.
Résultat dynamic

Query() public méthode

Attempts to search for records matching the given parameters. Parameters are optional and context sensitive. An exception will be thrown if an invalid parameter is given. This methods lacks a "parameters" dictionary argument and as a result will grab all records for the specified endpoint.
public Query ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic
subscriberID String Subscriber I.
jobSearchID String Job search I.
batchID String Batch I.
Résultat dynamic

RemoveParameter() public méthode

Removes the a single parameter from the parameter dictionary.
public RemoveParameter ( String key ) : APIResource
key String Key.
Résultat APIResource

Retrieve() public méthode

Attempts to retrieve a record using the given parameters using a GET. Arguments are optional and context sensitive. An exception will be thrown if an invalid parameter is given.
public Retrieve ( String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic
subscriberID String Subscriber ID.
jobSearchID String Job Search ID.
batchID String Batch ID.
Résultat dynamic

Submit() public méthode

Attempts to retrieve a record using the given parameters using a POST. Arguments except the "parameters" Dictionary are optional and context sensitive. An exception will be thrown if an invalid parameter is given.
public Submit ( String>.Dictionary parameters, String subscriberID = "", String jobSearchID = "", String batchID = "" ) : dynamic
parameters String>.Dictionary Parameters.
subscriberID String Subscriber I.
jobSearchID String Job search I.
batchID String Batch I.
Résultat dynamic

Property Details

batchID protected_oe property

protected String batchID
Résultat String

endpoint protected_oe property

protected String endpoint
Résultat String

handle protected_oe property

protected JobAlertsAPI handle
Résultat JobAlertsAPI

jobSearchID protected_oe property

protected String jobSearchID
Résultat String

operatingMode protected_oe property

protected APIResourceMode operatingMode
Résultat APIResourceMode

subscriberID protected_oe property

protected String subscriberID
Résultat String