MessageTemplatesHttpClientV1 class
Properties
-
baseRoute
↔ String?
-
The base route.
getter/setter pairinherited
-
client
↔ Client?
-
The HTTP client.
getter/setter pairinherited
-
connectionResolver
↔ HttpConnectionResolver
-
The connection resolver.
getter/setter pairinherited
-
connectTimeout
↔ int
-
The connection timeout in milliseconds.
getter/setter pairinherited
-
correlationIdLocation
↔ String
-
getter/setter pairinherited
-
counters
↔ CompositeCounters
-
The performance counters.
getter/setter pairinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
The default headers to be added to every request.
getter/setter pairinherited
-
logger
↔ CompositeLogger
-
The logger.
getter/setter pairinherited
-
options
↔ ConfigParams
-
The configuration options.
getter/setter pairinherited
-
retries
↔ int
-
The number of retries.
getter/setter pairinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeout
↔ int
-
The invocation timeout in milliseconds.
getter/setter pairinherited
-
tracer
↔ CompositeTracer
-
The tracer.
getter/setter pairinherited
-
uri
↔ String?
-
The remote service uri which is calculated on open.
getter/setter pairinherited
Methods
-
addCorrelationId(Map<String, String>? params, String? correlationId)
→ Map<String, String>
-
Adds a correlation id (correlation_id) to invocation parameter map.
inherited
-
addFilterParams(Map<String, String>? params, FilterParams? filter)
→ Map<String, String>
-
Adds filter parameters (with the same name as they defined)
to invocation parameter map.
inherited
-
addPagingParams(Map<String, String>? params, PagingParams? paging)
→ Map<String, String>
-
Adds paging parameters (skip, take, total) to invocation parameter map.
inherited
-
call(String method, String route, String? correlationId, Map<String, String> params, [dynamic data])
→ Future
-
Calls a remote method via HTTP/REST protocol.
inherited
-
callCommand(String name, String? correlationId, dynamic params)
→ Future
-
Calls a remote method via HTTP commadable protocol.
The call is made via POST operation and all parameters are sent in body object.
The complete route to remote method is defined as baseRoute + "/" + name.
inherited
-
close(String? correlationId)
→ Future
-
Closes component and frees used resources.
inherited
-
configure(ConfigParams config)
→ void
-
Configures component by passing configuration parameters.
inherited
-
createRequestRoute(String route)
→ String
-
inherited
-
createTemplate(String? correlationId, MessageTemplateV1 template)
→ Future<MessageTemplateV1?>
-
Creates a template.
override
-
deleteTemplateById(String? correlationId, String id)
→ Future<MessageTemplateV1?>
-
Deleted a template by it's unique id.
override
-
getTemplateById(String? correlationId, String id)
→ Future<MessageTemplateV1?>
-
Gets a template by its unique id.
override
-
getTemplateByIdOrName(String? correlationId, String idOrName)
→ Future<MessageTemplateV1?>
-
Gets a template by its unique id or name.
override
-
getTemplates(String? correlationId, FilterParams? filter, PagingParams? paging)
→ Future<DataPage<MessageTemplateV1>>
-
Gets a page of templates retrieved by a given filter.
override
-
instrument(String? correlationId, String name)
→ InstrumentTiming
-
Adds instrumentation to log calls and measure call time.
It returns a Timing object that is used to end the time measurement.
inherited
-
instrumentError(String? correlationId, String name, dynamic err, [bool? reerror = false])
→ void
-
Adds instrumentation to error handling.
inherited
-
isOpen()
→ bool
-
Checks if the component is opened.
Returns true if the component has been opened and false otherwise.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
open(String? correlationId)
→ Future
-
Opens the component.
inherited
-
setReferences(IReferences references)
→ void
-
Sets references to dependent components.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateTemplate(String? correlationId, MessageTemplateV1 template)
→ Future<MessageTemplateV1?>
-
Updates a template.
override