sponge_client_dart library

Classes

ActionCallParams
An action call request body.
ActionCallRequest
An action call request.
ActionCallResponse
An action call response.
ActionCallResultInfo
ActionData
ActionExecutionInfo
An action execution related info.
ActionMeta
An action metadata.
AnnotatedValue
AnyType
An any type. It may be used in situations when type is not important.
AnyTypeUnitConverter
BaseRequestParams
BinaryType
A binary (byte array) type. Provides an optional property mimeType.
BinaryTypeUnitConverter
BooleanType
A boolean type.
BooleanTypeUnitConverter
CategoryMeta
A category metadata.
ClientOutputStreamValue
CollectionType<T>
DataType<T>
A data type. Used for example in action arguments metadata.
DataTypeConstants
DataTypeUtils
DateTimeType
A date/time type.
DateTimeTypeUnitConverter
DecoratedValue
DefaultFeatureConverter
A default feature converter.
DefaultTypeConverter
A default type converter.
DynamicType
An dynamic type representing dynamically typed values. A value of this type has to be an instance of DynamicValue.
DynamicTypeUnitConverter
DynamicValue
A dynamic value that specifies its type.
ErrorResponse
EventData
FeatureConverter
A feature converter.
Features
FeaturesUtils
Formats
GenericRequest
GeoCrs
GeoLayer
GeoMap
GeoMapFeatureUnitConverter
GeoMarkerLayer
GeoPosition
GeoPositionFeatureUnitConverter
GeoTileLayer
GeoWmsLayer
GetActionsParams
A get actions request params.
GetActionsRequest
A get actions request.
GetActionsResponse
A get actions response.
GetActionsValue
GetEventTypesParams
A get event types request params.
GetEventTypesRequest
A get event types request.
GetEventTypesResponse
A get event types response.
GetFeaturesRequest
A get features request
GetFeaturesResponse
A get features response.
GetKnowledgeBasesRequest
A get knowledge bases request.
GetKnowledgeBasesResponse
A get knowledge bases response.
GetVersionRequest
A get version request
GetVersionResponse
A get version response.
IconFeatureUnitConverter
IconInfo
InputStreamType
An input stream type.
InputStreamTypeUnitConverter
IntegerType
An integer type (commonly used integer type or long).
IntegerTypeUnitConverter
IsActionActiveEntry
An action active request entry.
IsActionActiveParams
An action active request params.
IsActionActiveRequest
An action active request.
IsActionActiveResponse
An action active response.
JsonRpcConstants
JSON-RPC 2.0 constants.
KnowledgeBaseMeta
A knowledge base metadata.
ListType
A list type. This type requires an elementType parameter, which is is a type of list elements.
ListTypeUnitConverter
LoginRequest
A login request.
LoginResponse
A login response.
LoginValue
A login response value.
LogoutRequest
A logout request.
LogoutResponse
A logout response.
MapType
A map type. This type requires two parameters: a type of keys and a type of values in the map.
MapTypeUnitConverter
NumberType
A number type, that include both integer and floating-point numbers.
NumberTypeUnitConverter
ObjectType
An object. This type requires a class name (typically a Java class name) as a constructor parameter.
ObjectTypeUnitConverter
Doesn't support reflection.
OutputStreamActionCallResponse
OutputStreamType
An output stream type.
OutputStreamTypeUnitConverter
PageableList<E>
ProcessorQualifiedVersion
A processor qualified version.
ProvideActionArgsParams
A provide action arguments request params.
ProvideActionArgsRequest
A provide action arguments request.
ProvideActionArgsResponse
A provide action arguments response.
ProvidedMeta
A provided object metadata.
ProvidedValue<T>
A provided object value and a possible value set.
QualifiedDataType<T>
A qualified data type.
RecordType
A record type. This type requires a list of record field types. A value of this type has to be an instance of Map<String, dynamic> with elements corresponding to the field names and values.
RecordTypeUnitConverter
RefTypeBundle
RefTypeValueBundle
ReloadRequest
A reload request.
ReloadResponse
A reload response.
RemoteEvent
A Sponge Remote API event.
RequestHeader
A request header.
RequestParams
A request params.
ResponseError
A response error.
ResponseHeader
A response header.
ResponseResult<T>
A response result.
SendEventParams
A send event request params.
SendEventRequest
A send event request.
SendEventResponse
A send event response body.
SpongeClient
A Sponge Remote API client. [...]
SpongeClientConfiguration
A Sponge Remote API configuration.
SpongeClientConstants
The Sponge client constants.
SpongeClientUtils
A set of utility methods.
SpongeRequest<T>
A base request.
SpongeRequestContext
SpongeResponse<T>
A base response.
StringType
A string type.
StringTypeUnitConverter
SubAction
A sub-action specification.
SubActionArg
A sub-action argument substitution.
SubActionArgSpec
SubActionFeaturesUnitConverter
SubActionFeatureUnitConverter
SubActionResult
A sub-action result substitution.
SubActionSpec
SubmittableMeta
A submittable object metadata.
TypeConverter
A type converter.
TypedParamsRequest<T extends RequestParams>
A base request.
TypeType
A type representing a data type. A value of this type has to be an instance of DataType.
TypeTypeUnitConverter
UnitFeatureConverter
An unit feature converter. All implementations should be stateless because one instance is shared by different invocations of marshal and unmarshal methods.
UnitTypeConverter<T, D extends DataType>
An unit type converter. All implementations should be stateless because one instance is shared by different invocations of marshal and unmarshal methods.
Validate
ValueSetMeta
A value set metadata.
VoidType
A void type that may be used to specify that an action returns no meaningful result.
VoidTypeUnitConverter

Enums

DataTypeKind
A data type kind.
DateTimeKind
A date/time kind.
GeoLayerType
ProvidedMode
A provided mode.
SubActionType

Typedefs

ObjectTypeUnitConverterMapper = Future Function(TypeConverter converter, dynamic value)
OnRequestSerializedListener = void Function(SpongeRequest request, String requestString)
A callback that will be invoked when the request is serialized. Remember to obfuscate the password if the requestString is to be shown.
OnResponseDeserializedListener = void Function(SpongeRequest request, SpongeResponse response, String responseString)
A callback that will be invoked when the response is deserialized.
ResponseCreateCallback<R extends SpongeResponse> = R Function(Response httpResponse)

Exceptions / Errors

InactiveActionException
A Sponge client exception for inactive action.
InvalidAuthTokenException
A Sponge client exception for invalid auth token.
InvalidKnowledgeBaseVersionException
A Sponge client exception for invalid knowledge base version.
InvalidUsernamePasswordException
A Sponge client exception for invalid username or password version.
SpongeClientException
A Sponge client exception.
SpongeException
A base Sponge exception.