PayPalHttpClient class

PayPal http client. Takes care of authorization. Re-authorizes when token expires and retries request

Constructors

PayPalHttpClient(PayPalEnvironment paypalEnvironment, {Client? client, AccessToken? accessToken, dynamic accessTokenUpdatedCallback(AccessToken)?, bool loggingEnabled = false})

Properties

accessToken AccessToken?
getter/setter pair
accessTokenUpdatedStream StreamController<AccessToken>
Listen to stream to receive updates whenever access token is updated
final
hashCode int
The hash code for this object.
no setterinherited
log → Logger
final
paypalEnvironment PayPalEnvironment
Live or Sandbox PayPal environment
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
userAgent String
final

Methods

authorize() Future<AccessToken>
Manually get a new access token. You shouldn't need to call this as the client will automatically request one as needed
close() → void
Closes the client and cleans up any resources associated with it.
inherited
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
get(Uri url, {Map<String, String>? headers}) Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
getUrl(String path, {Map<String, dynamic>? queryParameters}) Uri
Creates URL with the given path and currently configured environment
Sends an HTTP HEAD request with the given headers to the given URL.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
read(Uri url, {Map<String, String>? headers}) Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited