OAuthResponseText

Overview

The OAuthResponseText object is used for handling text-based responses during OAuth authentication. It provides methods to retrieve the response body, HTTP status code, and headers, making it easier to process and evaluate the OAuth service's responses.

The getBody() method returns the response body as a string, offering direct access to the textual content. The getCode() method retrieves the HTTP response code, represented as a number, to assess the success or failure of the request. For header management, the getHeader(name) method fetches a specific header's value based on its name, while the getHeaders() method provides an array containing all response headers.

For more information about authentication using the OAuth service, refer to the OAuth Provider from the Authentication section of this documentation.

Methods Summarized

Type
Name
Summary

Methods Detailed

getBody()

Returns: String

getCode()

Returns: Number

getHeader(name)

Parameters

Returns: String

getHeaders()

Returns: Array


Last updated