Request
in package
FinalYes
One prepared HTTP request: the verb, the absolute URL, the headers and the encoded body, plus the name of the API method it calls.
The method name (liveChatMessages.list) is what the quota meter charges and
what the log shows. The URL is never logged, because an API key or an OAuth
code can travel in it.
Tags
Table of Contents
Properties
- $content : string
- $endpoint : string
- $headers : array<string|int, mixed>
- $method : string
- $url : string
Methods
- __construct() : mixed
- __toString() : string
- getContent() : string
- getEndpoint() : string
- The API method it calls, e.g. `liveChatMessages.list`.
- getHeader() : ?string
- getHeaders() : array<string, string>
- getMethod() : string
- getUrl() : string
- The absolute URL, query included.
- withHeader() : self
Properties
$content read-only
private
string
$content
= ''
$endpoint read-only
private
string
$endpoint
$headers
private
array<string|int, mixed>
$headers
= []
$method read-only
private
string
$method
$url read-only
private
string
$url
Methods
__construct()
public
__construct(string $endpoint, string $method, string $url[, string $content = '' ][, array<string, string> $headers = [] ]) : mixed
Parameters
- $endpoint : string
-
The API method it calls, e.g.
liveChatMessages.list. - $method : string
- $url : string
- $content : string = ''
- $headers : array<string, string> = []
__toString()
public
__toString() : string
Return values
stringgetContent()
public
getContent() : string
Return values
stringgetEndpoint()
The API method it calls, e.g. `liveChatMessages.list`.
public
getEndpoint() : string
Return values
stringgetHeader()
public
getHeader(string $name) : ?string
Parameters
- $name : string
Return values
?stringgetHeaders()
public
getHeaders() : array<string, string>
Return values
array<string, string>getMethod()
public
getMethod() : string
Return values
stringgetUrl()
The absolute URL, query included.
public
getUrl() : string
Return values
stringwithHeader()
public
withHeader(string $name, string $value) : self
Parameters
- $name : string
- $value : string