REST.Client.TRESTClient Properties

From RAD Studio API Documentation
Jump to: navigation, search

AuthenticatorpublishedInstance of a subclass of TCustomAuthenticator to be used for authentication against the server.
AutoCreateParamspublishedIndicates whether or not the client should automatically include parameters from the base URL into its request.
BaseURLpublishedSpecifies the base URL for all API calls.
ComObjectpublicSpecifies the interface reference implemented by the component.
ComponentCountpublicIndicates the number of components owned by the component.
ComponentIndexpublicIndicates the position of the component in its owner's Components property array.
ComponentspublicLists all components owned by the component.
ComponentStatepublicDescribes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStylepublicGoverns the behavior of the component.
ContentTypepublishedAn internally used property that specifies the MIME (Multipurpose Internet Mail Extensions) type for POST or PUT requests.
DesignInfopublicContains information used by the Form designer.
DisposedprotectedDisposed is a read-only property that shows the current state of this object.
ExpressionsprotectedSpecifies a list of binding components that are using this source component.
FallbackCharsetEncodingpublishedSpecifies the character encoding for strings to be used if the server does not specify an encoding.
NamepublishedSpecifies the name of the component as referenced in code.
ObserverspublicIndicates the TObservers object added to the TComponent.
OwnerpublicIndicates the component that is responsible for streaming and freeing this component.
ParamspublishedSpecifies a container for all HTTP parameters to be passed with each request.
ProxyPasswordpublishedSpecifies a password for proxy authentication.
ProxyPortpublishedSpecifies a port number for the HTTP proxy server, if any.
ProxyServerpublishedSpecifies a server name for the proxy server, if any.
ProxyUsernamepublishedSpecifies a user name for the HTTP proxy server.
RaiseExceptionOn500publishedWhen True, raises an exception if a 500 Protocol exception occurs.
ScopeMappingsprotectedSpecifies an owned collection of scope mappings.
SynchronizedEventspublishedIndicates whether events (such as OnHTTPProtocolError) should run in the context of the main thread (SynchronizedEvents is True) or in the context of an arbitrary thread that you create with TCustomRESTRequest.ExecuteAsync (SynchronizedEvents is False).
TagpublishedStores a NativeInt integral value as a part of a component.
TransientParamspublicA container of all transient parameters the request uses.
UserAgentpublishedUser-Agent field of the request, which specifies information about the user agent that originates the request, that is, information about your application.
VCLComObjectpublicRepresents information used internally by components that support COM.