Click or drag to resize

IWebApi Interface
Provide methods to interact with current http request.

Namespace: Casewhere.WebTrigger.DSL
Assembly: Casewhere.WebTrigger (in Casewhere.WebTrigger.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
Copy
public interface IWebApi

The IWebApi type exposes the following members.

Methods
 NameDescription
Public methodCode exampleAbandonAuthorization Stop the flow of initial authorization
Public methodCode exampleCreateErrorResponse Create http error response with status code and message
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();
webApi.CreateErrorResponse(401, "You are not authorized");
Public methodCreateFileResponse(DocumentInfo, String, String) Create http file response with a given document info, media type and disposition header. The file can be downloaded or will be viewed in the browser client.
Public methodCode exampleCreateFileResponse(String, ActionStream, String, String) Create http file response with a given file name with an action named as beginWritingStream. That action is called when an output stream is available, allowing the action to write to it directly. Thus, allow we can write a largest file (more than 1GB with controlling memory usage).
Public methodCreateFileResponse(String, Byte, String, String) Create http file response with a given file name, file content, media type and disposition header. The file can be downloaded or will be viewed in the browser client.
Public methodCreateFileResponse(String, Stream, String, String) Create http file response with a given file name, file stream, media type and disposition header. The file can be downloaded or will be viewed in the browser client.
Public methodCreateFileResponse(String, String, String, String) Create http file response with a given file name, file path, media type and disposition header. The file can be downloaded or will be viewed in the browser client.
Public methodCode exampleCreateResponseT Create http response with data
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();
var data = new { FirstName = "Thao", LastName = "Dinh" };        
webApi.CreateResponse(data);
Public methodCreateTextResponse Create http response with text data
Public methodGetBrowserAgent Get the complete user-agent string of the client
Public methodCode exampleGetHeaders Get headers from the current request
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();        
var headers = webApi.GetHeaders();
Public methodCode exampleGetQueryString Get query string from the current request
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();        
var queryString = webApi.GetQueryString();
Public methodCode exampleGetUri Get URI from the current request
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();        
var uri = webApi.GetUri();
Public methodGetUserIp Get current user ip
Public methodCode exampleRedirect Redirect the specific url
Example
C#
Copy
var webApi = ctx.Use<IWebApi>();        
webApi.Redirect("https://api-local.casewhere.com/external/v0.1/trigger/kk-nemlogin-logout-callback?nonce=b3c7c6ea-f38a-4b2a-aa6e-9c69fce65ec1");
Top
See Also