Gjsify LogoGjsify Logo

Represents an HTTP message being sent or received.

status_code will normally be a #SoupStatus value, eg, %SOUP_STATUS_OK, though of course it might actually be an unknown status code. 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 reason_phrase in user-visible messages. Rather, you should look at status_code, and determine an end-user-appropriate message based on that and on what you were trying to do.

As described in the #SoupMessageBody documentation, the request_body and response_body data fields will not necessarily be filled in at all times. When the body fields are filled in, they will be terminated with a '\0' byte (which is not included in the length), so you can use them as ordinary C strings (assuming that you know that the body doesn't have any other '\0' bytes).

For a client-side #SoupMessage, request_body's data is usually filled in right before libsoup writes the request to the network, but you should not count on this; use soup_message_body_flatten() if you want to ensure that data is filled in. If you are not using #SoupRequest to read the response, then response_body's data will be filled in before #SoupMessage::finished is emitted. (If you are using #SoupRequest, then the message body is not accumulated by default, so response_body's data will always be %NULL.)

For a server-side #SoupMessage, request_body's %data will be filled in before #SoupMessage::got_body is emitted.

To prevent the %data field from being filled in at all (eg, if you are handling the data from a #SoupMessage::got_chunk, and so don't need to see it all at the end), call soup_message_body_set_accumulate() on response_body or request_body as appropriate, passing %FALSE.

Hierarchy

Index

Constructors

Properties

firstParty: Soup.URI

The #SoupURI loaded in the application when the message was queued.

gTypeInstance: TypeInstance
httpVersion: Soup.HTTPVersion
isTopLevelNavigation: boolean

Set when the message is navigating between top level domains.

method: string

the HTTP method

field
parent: GObject.Object
reasonPhrase: string

the status phrase associated with status_code

field
requestBody: Soup.MessageBody

the request body

field
requestBodyData: any

The message's HTTP request body, as a #GBytes.

requestHeaders: Soup.MessageHeaders

the request headers

field
responseBody: Soup.MessageBody

the response body

field
responseBodyData: any

The message's HTTP response body, as a #GBytes.

responseHeaders: Soup.MessageHeaders

the response headers

field
serverSide: boolean
siteForCookies: Soup.URI
statusCode: number

the HTTP status code

field
tlsCertificate: TlsCertificate

The #GTlsCertificate associated with the message

The verification errors on #SoupMessage:tls-certificate

uri: Soup.URI
$gtype: GType<Soup.Message>
name: string

Methods

  • 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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • contentSniffed(contentType: string, params: HashTable<string | number | symbol, string | number | boolean>): void
  • Parameters

    • contentType: string
    • params: HashTable<string | number | symbol, string | number | boolean>

    Returns void

  • disableFeature(featureType: GType<unknown>): void
  • This disables the actions of #SoupSessionFeatures with the given feature_type (or a subclass of that type) on msg, so that 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.

    Parameters

    • featureType: GType<unknown>

      the #GType of a #SoupSessionFeature

    Returns void

  • emit(sigName: "content-sniffed", params: HashTable<string | number | symbol, string | number | boolean>, ...args: any[]): void
  • emit(sigName: "finished", ...args: any[]): void
  • emit(sigName: "got-body", ...args: any[]): void
  • emit(sigName: "got-chunk", ...args: any[]): void
  • emit(sigName: "got-headers", ...args: any[]): void
  • emit(sigName: "got-informational", ...args: any[]): void
  • emit(sigName: "network-event", connection: IOStream, ...args: any[]): void
  • emit(sigName: "restarted", ...args: any[]): void
  • emit(sigName: "starting", ...args: any[]): void
  • emit(sigName: "wrote-body", ...args: any[]): void
  • emit(sigName: "wrote-body-data", ...args: any[]): void
  • emit(sigName: "wrote-chunk", ...args: any[]): void
  • emit(sigName: "wrote-headers", ...args: any[]): void
  • emit(sigName: "wrote-informational", ...args: any[]): void
  • emit(sigName: "notify::first-party", ...args: any[]): void
  • emit(sigName: "notify::flags", ...args: any[]): void
  • emit(sigName: "notify::http-version", ...args: any[]): void
  • emit(sigName: "notify::is-top-level-navigation", ...args: any[]): void
  • emit(sigName: "notify::priority", ...args: any[]): void
  • emit(sigName: "notify::request-body-data", ...args: any[]): void
  • emit(sigName: "notify::response-body-data", ...args: any[]): void
  • emit(sigName: "notify::server-side", ...args: any[]): void
  • emit(sigName: "notify::site-for-cookies", ...args: any[]): void
  • emit(sigName: "notify::tls-certificate", ...args: any[]): void
  • emit(sigName: "notify::tls-errors", ...args: any[]): void
  • emit(sigName: "notify::uri", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "content-sniffed"
    • params: HashTable<string | number | symbol, string | number | boolean>
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "finished"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "got-body"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "got-chunk"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "got-headers"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "got-informational"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "network-event"
    • connection: IOStream
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "restarted"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "starting"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "wrote-body"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "wrote-body-data"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "wrote-chunk"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "wrote-headers"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "wrote-informational"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::first-party"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::flags"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::http-version"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::is-top-level-navigation"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::priority"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::request-body-data"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::response-body-data"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::server-side"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::site-for-cookies"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::tls-certificate"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::tls-errors"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::uri"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • finished(): void
  • forceFloating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freezeNotify(): void
  • 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::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.

    Returns void

  • Gets the address msg's URI points to. After first setting the URI on a message, this will be unresolved, although the message's session will resolve it before sending the message.

    Returns Soup.Address

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Gets the HTTP version of msg. This is the minimum of the version from the request and the version from the response.

    Returns Soup.HTTPVersion

  • If msg is using https (or attempted to use https but got %SOUP_STATUS_SSL_FAILED), this retrieves the #GTlsCertificate associated with its connection, and the #GTlsCertificateFlags showing what problems, if any, have been found with that certificate.

    This is only meaningful with messages processed by a #SoupSession and is not useful for messages received by a #SoupServer

    Returns [boolean, TlsCertificate, TlsCertificateFlags]

  • getIsTopLevelNavigation(): boolean
  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • If msg is associated with a #SoupRequest, this returns that request. Otherwise it returns %NULL.

    Returns Request

  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • gotBody(): void
  • gotHeaders(): void
  • gotInformational(): void
  • isFeatureDisabled(featureType: GType<unknown>): boolean
  • Get whether #SoupSessionFeatures of the given feature_type (or a subclass of that type) are disabled on msg. See soup_message_disable_feature().

    Parameters

    • featureType: GType<unknown>

      the #GType of a #SoupSessionFeature

    Returns boolean

  • isFloating(): boolean
  • isKeepalive(): boolean
  • Determines whether or not msg's connection can be kept alive for further requests after processing msg, based on the HTTP version, Connection header, etc.

    Returns boolean

  • notify(propertyName: string): void
  • 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.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • on(sigName: "content-sniffed", callback: Soup.Message_ContentSniffedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "finished", callback: Soup.Message_FinishedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "got-body", callback: Soup.Message_GotBodySignalCallback, after?: boolean): EventEmitter
  • on(sigName: "got-chunk", callback: Message_GotChunkSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "got-headers", callback: Soup.Message_GotHeadersSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "got-informational", callback: Soup.Message_GotInformationalSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "network-event", callback: Soup.Message_NetworkEventSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "restarted", callback: Soup.Message_RestartedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "starting", callback: Soup.Message_StartingSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "wrote-body", callback: Soup.Message_WroteBodySignalCallback, after?: boolean): EventEmitter
  • on(sigName: "wrote-body-data", callback: Soup.Message_WroteBodyDataSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "wrote-chunk", callback: Message_WroteChunkSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "wrote-headers", callback: Soup.Message_WroteHeadersSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "wrote-informational", callback: Message_WroteInformationalSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::first-party", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::flags", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::http-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::is-top-level-navigation", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::priority", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::request-body-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::response-body-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::server-side", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::site-for-cookies", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::tls-certificate", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::tls-errors", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::uri", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "content-sniffed", callback: Soup.Message_ContentSniffedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "finished", callback: Soup.Message_FinishedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "got-body", callback: Soup.Message_GotBodySignalCallback, after?: boolean): EventEmitter
  • once(sigName: "got-chunk", callback: Message_GotChunkSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "got-headers", callback: Soup.Message_GotHeadersSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "got-informational", callback: Soup.Message_GotInformationalSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "network-event", callback: Soup.Message_NetworkEventSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "restarted", callback: Soup.Message_RestartedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "starting", callback: Soup.Message_StartingSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "wrote-body", callback: Soup.Message_WroteBodySignalCallback, after?: boolean): EventEmitter
  • once(sigName: "wrote-body-data", callback: Soup.Message_WroteBodyDataSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "wrote-chunk", callback: Message_WroteChunkSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "wrote-headers", callback: Soup.Message_WroteHeadersSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "wrote-informational", callback: Message_WroteInformationalSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::first-party", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::flags", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::http-version", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::is-top-level-navigation", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::priority", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::request-body-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::response-body-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::server-side", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::site-for-cookies", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::tls-certificate", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::tls-errors", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::uri", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • 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.

    Returns GObject.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().

    Returns GObject.Object

  • restarted(): void
  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets an alternate chunk-allocation function to use when reading msg's body when using the traditional (ie, non-#SoupRequest-based) API. Every time data is available to read, libsoup will call allocator, which should return a #SoupBuffer. (See #SoupChunkAllocator for additional details.) Libsoup will then read data from the network into that buffer, and update the buffer's length to indicate how much data it read.

    Generally, a custom chunk allocator would be used in conjunction with soup_message_body_set_accumulate() %FALSE and #SoupMessage::got_chunk, as part of a strategy to avoid unnecessary copying of data. However, you cannot assume that every call to the allocator will be followed by a call to your #SoupMessage::got_chunk handler; if an I/O error occurs, then the buffer will be unreffed without ever having been used. If your buffer-allocation strategy requires special cleanup, use soup_buffer_new_with_owner() rather than doing the cleanup from the #SoupMessage::got_chunk handler.

    The other thing to remember when using non-accumulating message bodies is that the buffer passed to the #SoupMessage::got_chunk handler will be unreffed after the handler returns, just as it would be in the non-custom-allocated case. If you want to hand the chunk data off to some other part of your program to use later, you'll need to ref the #SoupBuffer (or its owner, in the soup_buffer_new_with_owner() case) to ensure that the data remains valid.

    Parameters

    Returns void

  • setData(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setFirstParty(firstParty: Soup.URI): void
  • Sets first_party as the main document #SoupURI for msg. For details of when and how this is used refer to the documentation for #SoupCookieJarAcceptPolicy.

    Parameters

    • firstParty: Soup.URI

      the #SoupURI for the msg's first party

    Returns void

  • Sets the HTTP version on msg. The default version is %SOUP_HTTP_1_1. Setting it to %SOUP_HTTP_1_0 will prevent certain functionality from being used.

    Parameters

    Returns void

  • setIsTopLevelNavigation(isTopLevelNavigation: boolean): void
  • See the same-site spec for more information.

    Parameters

    • isTopLevelNavigation: boolean

      if %TRUE indicate the current request is a top-level navigation

    Returns void

  • 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 #SoupSessionSync (or with synchronous messages on a plain #SoupSession) because in the synchronous/blocking case, priority ends up being determined semi-randomly by thread scheduling.

    Parameters

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setRedirect(statusCode: number, redirectUri: string): void
  • Sets msg's status_code to status_code and adds a Location header pointing to redirect_uri. Use this from a #SoupServer when you want to redirect the client to another URI.

    redirect_uri can be a relative URI, in which case it is interpreted relative to msg's current URI. In particular, if redirect_uri is just a path, it will replace the path and query of msg's URI.

    Parameters

    • statusCode: number

      a 3xx status code

    • redirectUri: string

      the URI to redirect msg to

    Returns void

  • setRequest(contentType: string, reqUse: Soup.MemoryUse, reqBody: Uint8Array): void
  • Convenience function to set the request body of a #SoupMessage. If content_type is %NULL, the request body must be empty as well.

    Parameters

    • contentType: string

      MIME Content-Type of the body

    • reqUse: Soup.MemoryUse

      a #SoupMemoryUse describing how to handle req_body

    • reqBody: Uint8Array

      a data buffer containing the body of the message request.

    Returns void

  • setResponse(contentType: string, respUse: Soup.MemoryUse, respBody: Uint8Array): void
  • Convenience function to set the response body of a #SoupMessage. If content_type is %NULL, the response body must be empty as well.

    Parameters

    • contentType: string

      MIME Content-Type of the body

    • respUse: Soup.MemoryUse

      a #SoupMemoryUse describing how to handle resp_body

    • respBody: Uint8Array

      a data buffer containing the body of the message response.

    Returns void

  • setSiteForCookies(siteForCookies: Soup.URI): void
  • 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.

    Parameters

    • siteForCookies: Soup.URI

      the #SoupURI for the msg's site for cookies

    Returns void

  • setStatus(statusCode: number): void
  • Sets msg's status code to status_code. If status_code is a known value, it will also set msg's reason_phrase.

    Parameters

    • statusCode: number

      an HTTP status code

    Returns void

  • setStatusFull(statusCode: number, reasonPhrase: string): void
  • Sets msg's status code and reason phrase.

    Parameters

    • statusCode: number

      an HTTP status code

    • reasonPhrase: string

      a description of the status

    Returns void

  • Sets msg's URI to uri. If msg has already been sent and you want to re-send it with the new URI, you need to call soup_session_requeue_message().

    Parameters

    Returns void

  • starting(): void
  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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.

    Returns void

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • wroteBody(): void
  • wroteChunk(): void
  • wroteHeaders(): void
  • wroteInformational(): void
  • compatControl(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new empty #SoupMessage, which will connect to uri

    Parameters

    • method: string

      the HTTP method for the created request

    • uriString: string

      the destination endpoint (as a string)

    Returns Soup.Message

  • Creates a new empty #SoupMessage, which will connect to uri

    Parameters

    • method: string

      the HTTP method for the created request

    • uri: Soup.URI

      the destination endpoint (as a #SoupURI)

    Returns Soup.Message

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method