Skip to content

Request.md

Latest commit

 

History

History
136 lines (76 loc) · 2.96 KB

Request.md

File metadata and controls

136 lines (76 loc) · 2.96 KB

Constants

  • ACCOUNT_URL
  • API_URL
  • RETURN_ASSOC
  • RETURN_OBJECT

Methods

account

array SpotifyWebAPI\Request::account(string $method, string $uri, array $parameters, array $headers)

Make a request to the "account" endpoint.

Arguments

  • $method string - The HTTP method to use.
  • $uri string - The URI to request.
  • $parameters array - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by Request::setReturnType().
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

api

array SpotifyWebAPI\Request::api(string $method, string $uri, array $parameters, array $headers)

Make a request to the "api" endpoint.

Arguments

  • $method string - The HTTP method to use.
  • $uri string - The URI to request.
  • $parameters array - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by Request::setReturnType().
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

getLastResponse

array SpotifyWebAPI\Request::getLastResponse()

Get the latest full response from the Spotify API.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by Request::setReturnType().
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

getReturnType

string SpotifyWebAPI\Request::getReturnType()

Get a value indicating the response body type.

Return values

  • string A value indicating if the response body is an object or associative array.

send

array SpotifyWebAPI\Request::send(string $method, string $url, array $parameters, array $headers)

Make a request to Spotify.
You'll probably want to use one of the convenience methods instead.

Arguments

  • $method string - The HTTP method to use.
  • $url string - The URL to request.
  • $parameters array - Optional. Query string parameters or HTTP body, depending on $method.
  • $headers array - Optional. HTTP headers.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by Request::setReturnType().
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

setReturnType

void SpotifyWebAPI\Request::setReturnType(string $returnType)

Set the return type for the response body.

Arguments

  • $returnType string - One of the Request::RETURN_* constants.

Return values

  • void