Optionalproperties: Partial<Soup.Message.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeVarious message options.
Read-Onlyhttp_The HTTP protocol version to use.
Read-OnlyhttpThe HTTP protocol version to use.
Whether the message is an OPTIONS ping.
The Message is intended to be used to send
OPTIONS * to a server. When set to true, the
path of Message.uri will be ignored and
Message.method set to SOUP_METHOD_OPTIONS.
Set when the message is navigating between top level domains.
Whether the message is an OPTIONS ping.
The Message is intended to be used to send
OPTIONS * to a server. When set to true, the
path of Message.uri will be ignored and
Message.method set to SOUP_METHOD_OPTIONS.
Set when the message is navigating between top level domains.
The message's HTTP method.
Sets the priority of the Message. See Message.set_priority for further details.
Read-Onlyreason_The HTTP response reason phrase.
Read-OnlyreasonThe HTTP response reason phrase.
Read-Onlyremote_The remote Gio.SocketAddress of the connection associated with the message.
Read-OnlyremoteThe remote Gio.SocketAddress of the connection associated with the message.
Read-Onlyrequest_The HTTP request headers.
Read-OnlyrequestThe HTTP request headers.
Read-Onlyresponse_The HTTP response headers.
Read-OnlyresponseThe HTTP response headers.
Read-Onlystatus_The HTTP response status code.
Read-OnlystatusThe HTTP response status code.
Read-Onlytls_The Name of TLS ciphersuite negotiated for this message connection.
Read-Onlytls_The peer's Gio.TlsCertificate associated with the message.
Read-Onlytls_The verification errors on Message.tls_peer_certificate.
Read-Onlytls_The TLS protocol version negotiated for the message connection.
Read-OnlytlsThe Name of TLS ciphersuite negotiated for this message connection.
Read-OnlytlsThe peer's Gio.TlsCertificate associated with the message.
Read-OnlytlsThe verification errors on Message.tls_peer_certificate.
Read-OnlytlsThe TLS protocol version negotiated for the message connection.
Adds flags to the set of msg's flags.
a set of Soup.MessageFlags values
SignalconnectSignalconnect_Disables the actions of SessionFeatures with the
given feature_type (or a subclass of that type) on msg.
msg is processed as though the feature(s) hadn't been added to the
session. Eg, passing #SOUP_TYPE_CONTENT_SNIFFER for feature_type
will disable Content-Type sniffing on the message.
You must call this before queueing msg on a session; calling it on
a message that has already been queued is undefined. In particular,
you cannot call this on a message that is being requeued after a
redirect or authentication.
the GObject.GType of a SessionFeature
SignalemitReturns the unique idenfier for the last connection used.
This may be 0 if it was a cached resource or it has not gotten a connection yet.
An id or 0 if no connection.
Returns whether HTTP/1 version is currently demanded for the msg send.
true, when HTTP/1 is demanded, false otherwise.
Gets the HTTP version of msg.
This is the minimum of the version from the request and the version from the response.
the HTTP version
Gets whether msg is intended to be used to send OPTIONS * to a server.
true if the message is options ping, or false otherwise
Returns if this message is set as a top level navigation.
Used for same-site policy checks.
Whether the current request is a top-level navitation
Returns the method of this message.
A method such as SOUP_METHOD_GET
Get the MessageMetrics of msg.
If the flag Soup.MessageFlags.COLLECT_METRICS is not enabled for msg this will
return null.
Retrieves the MessagePriority.
If not set this value defaults to #SOUP_MESSAGE_PRIORITY_NORMAL.
the priority of the message.
Returns the reason phrase for the status of this message.
the phrase
Get the remote Gio.SocketAddress of the connection associated with the message.
The returned address can be null if the connection hasn't been established
yet, or the resource was loaded from the disk cache. In case of proxy
connections, the remote address returned is a Gio.ProxyAddress. If
Session.remote_connectable is set the returned address id for the
connection to the session's remote connectable.
a Gio.SocketAddress or null if the connection hasn't been established
Gets the name of the TLS ciphersuite negotiated for msg's connection.
the name of the TLS ciphersuite, or null if msg's connection is not SSL.
Gets the peer's Gio.TlsCertificate associated with msg's connection.
Note that this is not set yet during the emission of
Soup.Message::accept-certificate signal.
msg's TLS peer certificate, or null if msg's connection is not SSL.
Gets the errors associated with validating msg's TLS peer certificate.
Note that this is not set yet during the emission of
Soup.Message::accept-certificate signal.
a Gio.TlsCertificateFlags with msg's TLS peer certificate errors.
Gets the TLS protocol version negotiated for msg's connection.
If the message connection is not SSL, Gio.TlsProtocolVersion.UNKNOWN is returned.
Get whether SessionFeatures of the given feature_type
(or a subclass of that type) are disabled on msg.
the GObject.GType of a SessionFeature
true if feature is disabled, or false otherwise.
Determines whether or not msg's connection can be kept alive for
further requests after processing msg.
The result is based on the HTTP version, Connection header, etc.
true or false.
Queries if flags are present in the set of msg's flags.
a set of Soup.MessageFlags values
true if flags are enabled in msg
Removes flags from the set of msg's flags.
a set of Soup.MessageFlags values
Sets first_party as the main document GLib.Uri for msg.
For details of when and how this is used refer to the documentation for CookieJarAcceptPolicy.
Sets the specified flags on msg.
a set of Soup.MessageFlags values
Sets whether HTTP/1 version should be used when sending this message. Some connections can still override it, if needed.
Note the value is unset after the message send is finished.
value to set
Set whether msg is intended to be used to send OPTIONS * to a server.
When set to true, the path of Message.uri will be ignored and
Message.method set to SOUP_METHOD_OPTIONS.
the value to set
Sets whether the current request is a top-level navitation.
See the same-site spec for more information.
if true indicate the current request is a top-level navigation
Set msg's HTTP method to method.
the value to set
Sets the priority of a message.
Note that this won't have any effect unless used before the message is added to the session's message processing queue.
The message will be placed just before any other previously added message with lower priority (messages with the same priority are processed on a FIFO basis).
Setting priorities does not currently work with synchronous messages because in the synchronous/blocking case, priority ends up being determined semi-randomly by thread scheduling.
Set the request body of a Message.
If content_type is null and stream is not null the Content-Type header will
not be changed if present.
The request body needs to be set again in case msg is restarted
(in case of redirection or authentication).
MIME Content-Type of the body, or null if unknown
a Gio.InputStream to read the request body from
the byte length of stream or -1 if unknown
Set the request body of a Message from GLib.Bytes.
If content_type is null and bytes is not null the Content-Type header will
not be changed if present.
The request body needs to be set again in case msg is restarted
(in case of redirection or authentication).
Optionalcontent_type: stringMIME Content-Type of the body, or null if unknown
Optionalbytes: GLib.Bytesa GLib.Bytes with the request body data
Sets site_for_cookies as the policy URL for same-site cookies for msg.
It is either the URL of the top-level document or null depending on whether
the registrable domain of this document's URL matches the registrable domain
of its parent's/opener's URL. For the top-level document it is set to the
document's URL.
See the same-site spec for more information.
Sets the certificate to be used by msg's connection when a
client certificate is requested during the TLS handshake.
You can call this as a response to Soup.Message::request-certificate
signal, or before the connection is started. If certificate is null
the handshake will continue without providing a GTlsCertificate.
Note that the Gio.TlsCertificate set by this function will be ignored if
Session.tls_interaction is not null.
Optionalcertificate: Gio.TlsCertificatethe Gio.TlsCertificate to set, or null
Completes a certificate password request.
You must call this as a response to
Soup.Message::request-certificate-password signal, to notify msg that
the Gio.TlsPassword has already been updated.
StaticnewStaticnew_Staticnew_Staticnew_Staticnew_Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Represents an HTTP message being sent or received.
A Message represents an HTTP message that is being sent or received.
You would create a Message with Message.new or Message.new_from_uri, set up its fields appropriately, and send it.
Message.status_code will normally be a Status value, eg, Soup.Status.OK, though of course it might actually be an unknown status code. Message.reason_phrase is the actual text returned from the server, which may or may not correspond to the "standard" description of
status_code. At any rate, it is almost certainly not localized, and not very descriptive even if it is in the user's language; you should not use Message.reason_phrase in user-visible messages. Rather, you should look at Message.status_code, and determine an end-user-appropriate message based on that and on what you were trying to do.Note that libsoup's terminology here does not quite match the HTTP specification: in RFC 2616, an "HTTP-message" is either a Request, or a Response. In libsoup, a Message combines both the request and the response.