PFApplicationRestHandler Class |
Provides methods to handle requests of three types:
-Extended actions made to the item module. URLs follow this format: "RestItem/APPLICATION_NAME/CONTENTTYPE_NAME/ITEM_ID/ACTION_NAME/PARAMETER_1/PARAMETER_2/..."
-Actions not centered on a specific entity. URLs follow this format: "RestCustomAction/APPLICATION_NAME/ACTION_NAME/PARAMETER_1/PARAMETER_2/..."
-Requests made on a custom (not Packflow) resource. URLs follow this format: "RestCustomResource/APPLICATION_NAME/RESOURCE_NAME/PARAMETER_1/PARAMETER_2/..."
Posted values are available using a dedicated method.
This class is inherited in all applications for customization.
Inheritance HierarchyPackflow.RestPFApplicationRestHandler
Packflow.RestPFApplicationRestHandlerPFApplicationType
Namespace: Packflow.Rest
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
Syntaxpublic abstract class PFApplicationRestHandler
The PFApplicationRestHandler type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFApplicationRestHandler |
Properties| Name | Description | |
|---|---|---|
 | Application |
Gets the Packflow application.
|
| CustomHttpMethod |
Gets the HTTP method text. Only filled if the used Http method is not listed by the RestHttpMethod enum.
|
| HttpMethod |
Gets the HTTP method.
|
| Request |
Gets the request.
|
| RequestExpectsCamelCaseJson |
Gets a (request parameter) value indicating if the returned JSON should follow camel case.
Default value: false.
Query string parameter name: "camelCase".
|
| RequestExpectsIgnoredNullValues |
Gets a (request parameter) value indicating if the returned JSON should ignore null values.
Default value: true.
Query string parameter name: "ignoreNullValues".
|
| RequestExpectsPrettyJson |
Gets a (request parameter) value indicating if the returned JSON should be indented.
Default value: false.
Query string parameter name: "pretty".
|
| Response |
Gets the response.
|
Methods| Name | Description | |
|---|---|---|
| GetPostedValue |
Gets a posted parameter value.
|
| GetRequestBody |
Gets the request body.
|
| GetSerializerSettings |
Gets the serializer settings for JsonConvert (NewtonSoft).
|
 | HandleCustomActionRequest |
Handles Rest requests for custom actions with an URL following the format
"RestCustomAction/APPLICATION_NAME/ACTION_NAME/PARAMETER_1/PARAMETER_2/..." |
| HandleCustomResourceRequest |
Handles Rest requests for custom resources with an URL following the format
"RestCustomResource/APPLICATION_NAME/RESOURCE_NAME/PARAMETER_1/PARAMETER_2/..." |
| HandleItemCustomRequest |
Handles Rest requests for custom actions on an item with an URL following the format
"RestItem/APPLICATION_NAME/CONTENTTYPE_NAME/ITEM_ID/ACTION_NAME/PARAMETER_1/PARAMETER_2/..." |
| SerializeResult |
Serializes an object (using JSON) to be returned in the response. Respects request parameters.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also