Android Programming Press on the image to return to the main documentation page.

OkHttp

List of types:

OkHttpClient
OkHttpRequest
OkHttpResponse

OkHttpClient

OkHttpClient allows you to make Http requests. Instead of using OkHttpClient directly it is recommended to use OkHttpUtil2
modules which are much simpler to use.

Permissions:

android.permission.INTERNET

Events:

ResponseSuccess (Response As OkHttpResponse, TaskId As Int)
ResponseError (Response As OkHttpResponse, Reason As String, StatusCode As Int, TaskId As Int)

Members:


  Execute (HttpRequest As OkHttpRequest, TaskId As Int) As Boolean

  ExecuteCredentials (Request As OkHttpRequest, TaskId As Int, UserName As String, Password As String) As Boolean

  Initialize (EventName As String)

  InitializeAcceptAll (EventName As String)

  IsInitialized As Boolean

Members description:

Execute (HttpRequest As OkHttpRequest, TaskId As Int) As Boolean
Executes the OkHttpRequest asynchronously. ResponseSuccess or ResponseError events will be fired later.
If there is a request with the same TaskId already running then this method will return False and the new request will not be submitted.
ExecuteCredentials (Request As OkHttpRequest, TaskId As Int, UserName As String, Password As String) As Boolean
Same behavior as Execute. The UserName and Password will be used for Basic authentication and Digest authentication.
Initialize (EventName As String)
Initializes this object.
IMPORTANT: this object should be declared in Sub Process_Globals.
EventName - The prefix that will be used for ResponseSuccess and ResponseError events.
InitializeAcceptAll (EventName As String)
Similar to Initialize, with one important difference. All SSL certificates will be automatically accepted.
This method should only be used when trying to connect to a server located in a secured network.
IsInitialized As Boolean

OkHttpRequest


Events:

None

Members:


  InitializeDelete (URL As String)

  InitializeDelete2 (URL As String, Data() As Byte)

  InitializeGet (URL As String)

  InitializeHead (URL As String)

  InitializePatch (URL As String, InputStream As java.io.InputStream, Length As Int)

  InitializePatch2 (URL As String, Data() As Byte)

  InitializePost (URL As String, InputStream As java.io.InputStream, Length As Int)

  InitializePost2 (URL As String, Data() As Byte)

  InitializePut (URL As String, InputStream As java.io.InputStream, Length As Int)

  InitializePut2 (URL As String, Data() As Byte)

  RemoveHeaders (Name As String)

  SetContentEncoding (Encoding As String)

  SetContentType (ContentType As String)

  SetHeader (Name As String, Value As String)

  Timeout As Int

Members description:

InitializeDelete (URL As String)
Initializes the request and sets it to be a Http Delete method.
InitializeDelete2 (URL As String, Data() As Byte)
Initializes the request and sets it to be a Http Delete method with the given payload.
InitializeGet (URL As String)
Initializes the request and sets it to be a Http Get method.
InitializeHead (URL As String)
Initializes the request and sets it to be a Http Head method.
InitializePatch (URL As String, InputStream As java.io.InputStream, Length As Int)
Initializes the request and sets it to be a Http Patch method.
The specified InputStream will be read and added to the request.
InitializePatch2 (URL As String, Data() As Byte)
Initializes the request and sets it to be a Http Patch method.
The specified Data array will be added to the request.
Unlike InitializePost this method will enable the request to retry and send the data several times in case of IO errors.
InitializePost (URL As String, InputStream As java.io.InputStream, Length As Int)
Initializes the request and sets it to be a Http Post method.
The specified InputStream will be read and added to the request.
InitializePost2 (URL As String, Data() As Byte)
Initializes the request and sets it to be a Http Post method.
The specified Data array will be added to the request.
Unlike InitializePost this method will enable the request to retry and send the data several times in case of IO errors.
InitializePut (URL As String, InputStream As java.io.InputStream, Length As Int)
Initializes the request and sets it to be a Http Put method.
The specified InputStream will be read and added to the request.
InitializePut2 (URL As String, Data() As Byte)
Initializes the request and sets it to be a Http Put method.
The specified Data array will be added to the request.
Unlike InitializePost this method will enable the request to retry and send the data several times in case of IO errors.
RemoveHeaders (Name As String)
Removes all headers with the given name.
SetContentEncoding (Encoding As String)
Sets the encoding header of the request.
SetContentType (ContentType As String)
Sets the Mime header of the request.
This method should only be used with requests that have a payload.
SetHeader (Name As String, Value As String)
Sets the value of the header with the given name. If no such header exists then a new header will be added.
Timeout As Int
Gets or sets the request timeout, measured in milliseconds. Default value is 30,000 (30 seconds).

OkHttpResponse

An object that holds the response returned from the server.
The object is passed in the ResponseSuccess event.
You can choose to read the response synchronously or asynchronously.
It is important to release this object when it is not used anymore by calling Release.

Events:

StreamFinish (Success As Boolean, TaskId As Int)

Members:


  ContentEncoding As String [read only]

  ContentLength As Long [read only]

  ContentType As String [read only]

  ErrorResponse As String [read only]

  GetAsynchronously (EventName As String, Output As java.io.OutputStream, CloseOutput As Boolean, TaskId As Int) As Boolean

  GetHeaders As Map

  Release

  StatusCode As Int [read only]

Members description:

ContentEncoding As String [read only]
Returns the Content-Encoding header.
ContentLength As Long [read only]
Returns the response body length.
ContentType As String [read only]
Returns the Content-Type header.
ErrorResponse As String [read only]
Returns the server response as a string (for failed responses only).
GetAsynchronously (EventName As String, Output As java.io.OutputStream, CloseOutput As Boolean, TaskId As Int) As Boolean
Asynchronously reads the response and writes it to the given OutputStream.
If there is a request with the same TaskId already running then this method will return False, and the response object will be released.
The StreamFinish event will be raised after the response has been fully read.
EventName - The sub that will handle the StreamFinish event.
Output - The stream from the server will be written to this stream.
CloseOutput - Whether to close the specified output stream when done.
TaskId - The task id given to this task.
Example:
Sub Http_ResponseSuccess (Response As OkHttpResponse, TaskId As Int)
  Response.GetAsynchronously("ImageResponse", _
    File.OpenOutput(File.DirInternalCache, "image.jpg", False), True, TaskId)
End Sub

Sub ImageResponse_StreamFinish (Success As Boolean, TaskId As Int)
  If Success = False Then
    Msgbox(LastException.Message, "Error")
    Return
  End If
  ImageView1.Bitmap = LoadBitmap(File.DirInternalCache, "image.jpg")
End Sub
GetHeaders As Map
Returns a Map object with the response headers.
Each elements is made of a key which is the header name and a value which is a list containing the values (one or more).
Example:
Dim list1 As List
list1 = response.GetHeaders.Get("Set-Cookie")
For i = 0 To list1.Size - 1
  Log(list1.Get(i))
Next
Release
Frees resources allocated for this object.
StatusCode As Int [read only]
Returns the response Http code.
Returns -1 is the status code is not available.
Top