Back to Seed Clases

Soup

Classes

Interfaces

Structs

Unions

Enums

Struct Soup.URI

Import line:	Soup = imports.gi.Soup;
GIR File:	Soup-2.4.gir
C documentation:	SoupURI
Struct :	URI

A SoupURI represents a (parsed) URI. SoupURI supports RFC 3986
(URI Generic Syntax), and can parse any valid URI. However, libsoup
only uses "http" and "https" URIs internally; You can use
SOUP_URI_VALID_FOR_HTTP() to test if a SoupURI is a valid HTTP
URI.
is always all lowercase. (If you parse a URI with a non-lowercase
scheme, it will be converted to lowercase.) The macros
SOUP_URI_SCHEME_HTTP and SOUP_URI_SCHEME_HTTPS provide the
interned values for "http" and "https" and can be compared against
URI scheme values.
(ie, separated by a colon; RFC 3986 only talks about a single
"userinfo" field). Note that password is not included in the
output of soup_uri_to_string(). libsoup does not normally use these
fields; authentication is handled via SoupSession signals.
URI. If the URI doesn't contain a hostname, host will be NULL,
and if it doesn't specify a port, port may be 0. However, for
"http" and "https" URIs, host is guaranteed to be non-NULL
(trying to parse an http URI with no host will return NULL), and
to use when it is not specified in the URI).
an empty string either; if the input URI has no path, the parsed
SoupURI will have a path of "/".
soup_form_decode() may be useful for parsing query.
Note that path, query, and fragment may contain
%-encoded characters. soup_uri_new() calls
soup_uri_normalize() on them, but not soup_uri_decode(). This is
necessary to ensure that soup_uri_to_string() will generate a URI
that has exactly the same meaning as the original. (In theory,
SoupURI should leave user, password, and host partially-encoded
as well, but this would be more annoying than useful.)

Properties
Properties		Defined By
	fragment : String	Soup.URI
	host : String	Soup.URI
	password : String	Soup.URI
	path : String	Soup.URI
	port : guint32	Soup.URI
	query : String	Soup.URI
	scheme : String	Soup.URI
	user : String	Soup.URI

Methods / Constructors
Method / Constructor		Defined By
	new Soup.URI () Create a new Soup.URI Create a new Soup.URI
	new Soup.URI.c_new (String *uri_string) : Soup.URI Create a new Soup.URI Create a new Soup.URI Parameters: String uri_string* Required (not null) a URI Returns: Soup.URI a SoupURI, or NULL.
	copy () : Soup.URI Copies uri Copies uri Returns: Soup.URI a copy of uri, which must be freed with soup_uri_free()	Soup.URI
	copy_host () : Soup.URI Makes a copy of uri, considering only the protocol, host, and port Makes a copy of uri, considering only the protocol, host, and port Returns: Soup.URI the new SoupUri	Soup.URI
	equal (URI *uri2) : gboolean Tests whether or not uri1 and uri2 are equal in all parts Tests whether or not uri1 and uri2 are equal in all parts Parameters: Soup.URI uri2* Required (not null) another SoupURI Returns: gboolean TRUE or FALSE	Soup.URI
	free () : none Frees uri. Frees uri. Returns: none	Soup.URI
	get_fragment () : String Gets uri's fragment. Gets uri's fragment. Returns: String uri's fragment.	Soup.URI
	get_host () : String Gets uri's host. Gets uri's host. Returns: String uri's host.	Soup.URI
	get_password () : String Gets uri's password. Gets uri's password. Returns: String uri's password.	Soup.URI
	get_path () : String Gets uri's path. Gets uri's path. Returns: String uri's path.	Soup.URI
	get_port () : guint32 Gets uri's port. Gets uri's port. Returns: guint32 uri's port.	Soup.URI
	get_query () : String Gets uri's query. Gets uri's query. Returns: String uri's query.	Soup.URI
	get_scheme () : String Gets uri's scheme. Gets uri's scheme. Returns: String uri's scheme.	Soup.URI
	get_user () : String Gets uri's user. Gets uri's user. Returns: String uri's user.	Soup.URI
	new_with_base (String *uri_string) : Soup.URI Parses uri_string* relative to base. Parses uri_string relative to base. Parameters: String uri_string Required (not null) the URI Returns: Soup.URI a parsed SoupURI.	Soup.URI
	set_fragment (String *fragment) : none Sets uri's fragment to fragment. Sets uri's fragment to fragment. Parameters: String fragment* Required (not null) the fragment Returns: none	Soup.URI
	set_host (String *host) : none Sets uri's host to host. Sets uri's host to host. If host* is an IPv6 IP address, it should not include the brackets required by the URI syntax; they will be added automatically when converting uri to a string. Parameters: String host Required (not null) the hostname or IP address, or NULL Returns: none	Soup.URI
	set_password (String *password) : none Sets uri's password to password. Sets uri's password to password. Parameters: String password* Required (not null) the password, or NULL Returns: none	Soup.URI
	set_path (String *path) : none Sets uri's path to path. Sets uri's path to path. Parameters: String path* Required (not null) the path Returns: none	Soup.URI
	set_port (guint32 *port) : none Sets uri's port to port. Sets uri's port to port. If port* is 0, uri will not have an explicitly-specified port. Parameters: guint32 port Required (not null) the port, or 0 Returns: none	Soup.URI
	set_query (String *query) : none Sets uri's query to query. Sets uri's query to query. Parameters: String query* Required (not null) the query Returns: none	Soup.URI
	set_query_from_form (Object *form) : none Sets uri's query to the result of encoding form* according to the HTML form rules. Sets uri's query to the result of encoding form according to the HTML form rules. See soup_form_encode_hash() for more information. Parameters: Object form Required (not null) a GHashTable containing HTML form information Returns: none	Soup.URI
	set_scheme (String *scheme) : none Sets uri's scheme to scheme. Sets uri's scheme to scheme. This will also set uri's port to the default port for scheme, if known. Parameters: String scheme* Required (not null) the URI scheme Returns: none	Soup.URI
	set_user (String *user) : none Sets uri's user to user. Sets uri's user to user. Parameters: String user* Required (not null) the username, or NULL Returns: none	Soup.URI
	to_string (gboolean *just_path_and_query) : String Returns a string representing uri. Returns a string representing uri. If just_path_and_query* is TRUE, this concatenates the path and query together. That is, it constructs the string that would be needed in the Request-Line of an HTTP request for uri. Parameters: gboolean just_path_and_query Required (not null) if TRUE, output just the path and query portions Returns: String a string representing uri, which the caller must free.	Soup.URI
	uses_default_port () : gboolean Tests if uri uses the default port for its scheme. Tests if uri uses the default port for its scheme. (Eg, 80 for http.) (This only works for http and https; libsoup does not know the default ports of other protocols.) Returns: gboolean TRUE or FALSE	Soup.URI

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Soup Method	Soup.cookie_parse (String *header, URI origin) : Soup.Cookie Parses header* and returns a SoupCookie.
Soup.Auth Method	get_protection_space (URI *source_uri) : Array Returns a list of paths on the server which auth* extends over.
Soup.Cookie Method	applies_to_uri (URI *uri) : gboolean Tests if cookie* should be sent to uri.
Soup.CookieJar Method	get_cookies (URI *uri, gboolean for_http) : String Retrieves (in Cookie-header form) the list of cookies that would be sent with a request to uri*.
Soup.CookieJar Method	set_cookie (URI *uri, String cookie) : none Adds cookie* to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.
Soup.CookieJar Method	set_cookie_with_first_party (URI *uri, URI first_party, String cookie) : none Adds cookie* to jar, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.
Soup.Message Property	first_party : Soup.URI
Soup.Message Property	uri : Soup.URI
Soup.Message Method	new Soup.Message.from_uri (String *method, URI uri*) : Soup.Message Create a new Soup.Message
Soup.Message Method	get_first_party () : Soup.URI
Soup.Message Method	get_uri () : Soup.URI Gets msg's URI
Soup.Message Method	set_first_party (URI *first_party) : none Sets first_party* as the main document SoupURI for msg.
Soup.Message Method	set_uri (URI *uri) : none Sets msg's URI to uri*.
Soup.ProxyURIResolver Method	get_proxy_uri_async (URI *uri, MainContext async_context, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously determines a proxy URI to use for msg* and calls
Soup.ProxyURIResolver Method	get_proxy_uri_sync (URI *uri, Cancellable cancellable, URI proxy_uri) : guint32 Synchronously determines a proxy URI to use for uri*.
Soup.Session Property	proxy_uri : Soup.URI
Soup.Session Method	prepare_for_uri (URI *uri*) : none