arri_client library

Classes

ArriErrorBuilder<T extends Exception>

ArriModel

ArriResult<T>

Container for holding a request data or a request error

ArriResultErr<T>

ArriResultOk<T>

EventSource<T>

ParseSseEventsResult<T>

SseDoneEvent<TData>

SseEvent<TData>

SseLineResult

SseMessageEvent<TData>

SseRawEvent<TData>

Enums

HttpMethod

Enum of available HTTP methods

SseLineResultType

Properties

timeoutDefault → Duration

final

Functions

arriRequest(String url, {Client? httpClient, HttpMethod method = HttpMethod.get, Map<String, dynamic>? params, FutureOr<Map<String, String>> headers()?, Map<String, String>? query, Encoding? encoding, String? clientVersion, Duration? timeout}) → Future<Response>

Perform a raw http request

bigIntFromDynamic(dynamic input, BigInt fallback) → BigInt

dateTimeFromDynamic(dynamic input, DateTime fallback) → DateTime

dateTimeListFromDynamic(dynamic input) → List<DateTime>

doubleFromDynamic(dynamic input, double fallback) → double

doubleListFromDynamic(dynamic input) → List<double>

intFromDynamic(dynamic input, int fallback) → int

intListFromDynamic(dynamic input) → List<int>

listsAreEqual(List? list1, List? list2, {bool log = false}) → bool

listToHashCode(List items) → int

mapsAreEqual(Map? map1, Map? map2, {bool log = false}) → bool

mapToHashCode(Map input) → int

nullableBigIntFromDynamic(dynamic input) → BigInt?

nullableDateTimeFromDynamic(dynamic input) → DateTime?

nullableDateTimeListFromDynamic(dynamic input) → List<DateTime?>

nullableDoubleFromDynamic(dynamic input) → double?

nullableDoubleListFromDynamic(dynamic input) → List<double?>

nullableIntFromDynamic(dynamic input) → int?

nullableIntListFromDynamic(dynamic input) → List<int?>

nullableTypeFromDynamic<T>(dynamic input) → T?

nullableTypeListFromDynamic<T>(dynamic input) → List<T?>

parsedArriRequest<T, E extends Exception>(String url, {Client? httpClient, HttpMethod method = HttpMethod.post, Map<String, dynamic>? params, FutureOr<Map<String, String>> headers()?, Duration? timeout, dynamic onError(Object)?, String? clientVersion, required T parser(String)}) → Future<T>

Helper function for performing raw HTTP request to an Arri RPC server This function will throw an ArriRequestError if it fails

parsedArriRequestSafe<T>(String url, {Client? httpClient, HttpMethod httpMethod = HttpMethod.get, Map<String, dynamic>? params, FutureOr<Map<String, String>> headers()?, required T parser(String), String? clientVersion}) → Future<ArriResult<T>>

Perform a raw HTTP request to an Arri RPC server. This function does not thrown an error. Instead it returns a request result in which both value and the error can be null.

parsedArriSseRequest<T>(String url, {Client? httpClient, required HttpMethod method, required T parser(String data), Map<String, dynamic>? params, FutureOr<Map<String, String>> headers()?, Duration? retryDelay, int? maxRetryCount, SseHookOnMessage<T>? onMessage, SseHookOnOpen<T>? onOpen, SseHookOnClose<T>? onClose, SseHookOnError<T>? onError, String? lastEventId, String? clientVersion, int? heartbeatTimeoutMultiplier, Duration? timeout}) → EventSource<T>

parseSseEvents<T>(String input, T dataParser(String)) → ParseSseEventsResult<T>

typeFromDynamic<T>(dynamic input, T fallback) → T

typeListFromDynamic<T>(dynamic input, T fallback) → List<T>

Typedefs

SseHookOnClose<T> = void Function(EventSource<T> connection)

SseHookOnError<T> = void Function(ArriError error, EventSource<T> connection)

SseHookOnMessage<T> = void Function(T message, EventSource<T> connection)

SseHookOnOpen<T> = void Function(StreamedResponse response, EventSource<T> connection)

Exceptions / Errors

ArriError

Serializable request error that can parse the error responses from an Arri RPC server.