Url Dart Reference Documentation
CkUrl
Current Version: 11.6.1
Chilkat.Url
Call
Read the hostname and determine whether it is a DNS name, IPv4 address,
or IPv6 address.
Access the URL path, query string, and combined path-with-query value for
request construction or routing.
Extract embedded userinfo credentials when a URL contains a login and
password component.
Determine the explicit or implied port and whether the URL represents an
SSL/TLS connection.
Read the URL fragment separately from the path and query for workflows
that need anchor or client-side state information.
For an extended overview, see
Url Class Overview.
Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.
Chilkat.Url is a focused URL parsing class. Given a full URL, it
extracts the hostname, host type, login, password, path, query string,
fragment, port, and SSL/TLS status into easy-to-read properties. It is useful
when application code needs to inspect, validate, route, log, or pass URL
parts to lower-level networking or API code.
Parse full URLs
ParseUrl to break a complete URL into structured
properties that can be inspected individually.
Host and host type
Path and query
Login and password
Port and TLS status
Fragment handling
Url when the application needs to decompose a URL before
making a request or applying custom logic. Parse the full URL, read the
properties needed by the caller, then pass the relevant pieces to classes
such as Chilkat.Http, Chilkat.Rest, or
Chilkat.Socket. Use Url for parsing; use the
higher-level networking classes to actually send the request.
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final url = CkUrl();
// ... the native object is released when `url` is garbage collected, or now with url.dispose().Creates the underlying native Chilkat object. Use a CkUrl only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
url.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkUrl.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
DebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Frag
String get frag
Contains any text following a fragment marker (#) in the URL, excluding the fragment marker. Given the URI http://www.contoso.com/index.htm#main, the fragment is main.
Host
String get host
The DNS host name or IP address part of the URL. For example, if the URL is http://www.contoso.com:8080/, the Host is www.contoso.com. If the URL is https://192.168.1.124/test.html, the Host is 192.168.1.124.
HostType
String get hostType
The type of the host name specified in the URL. Possible values are:
dns: The host name is a domain name system (DNS) style host name.ipv4: The host name is an Internet Protocol (IP) version 4 host address.ipv6: The host name is an Internet Protocol (IP) version 6 host address.
LastErrorHtml
String get lastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
String get lastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
String get lastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Login
String get login
If the URL contains a login and password, this is the login part. For example, if the URL is http://user:password@www.contoso.com/index.htm , then the login is user.
Password
String get password
If the URL contains a login and password, this is the password part. For example, if the URL is http://user:password@www.contoso.com/index.htm , then the password is password.
Path
String get path
The path (and params) part of the URL, excluding the query and fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1,
then the path is /gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3.
PathWithQueryParams
String get pathWithQueryParams
The path (and params) part of the URL, including the query params, but excluding the fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1,
then then this property returns /gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1.
Port
int get port
The port number of the URL.
For example, if the URL is http://www.contoso.com:8080/, the port number is 8080.
If the URL is https://192.168.1.124/test.html, the port number is the default 80.
If the URL is https://www.amazon.com/, the port number is the default SSL/TLS port 443.
Query
String get query
The query part of the URL, excluding the fragment. If the URL is: http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1#frag,
then the query is pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1.
Scheme
String get scheme
The scheme part of the URL. For example, if the URL is https://www.contoso.com:8080/, the Scheme is https.
Ssl
bool get ssl
true if the URL indicates SSL/TLS, otherwise false. A URL beginning with https:// indicates SSL/TLS.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
String get version
Methods
ParseUrl
Parses a full URL. After parsing, the various parts of the URL are available iin the properties.
Returns normally on success; throws a ChilkatException on failure.