Gjsify LogoGjsify Logo

All the fields in the #GDataCommentable structure are private and should never be accessed directly

interface

Hierarchy

Index

Constructors

Properties

constructed_from_xml: boolean

Specifies whether the object was constructed by parsing XML or manually.

content: string

The content of the entry. This is mutually exclusive with #GDataEntry:content.

For more information, see the Atom specification.

content_uri: string

A URI pointing to the location of the content of the entry. This is mutually exclusive with #GDataEntry:content.

For more information, see the Atom specification.

etag: string

An identifier for a particular version of the entry. This changes every time the entry on the server changes, and can be used for conditional retrieval and locking.

For more information, see the GData specification.

g_type_instance: TypeInstance
id: string

A permanent, universally unique identifier for the entry, in IRI form. This is %NULL for new entries (i.e. ones which haven't yet been inserted on the server, created with gdata_entry_new()), and a non-empty IRI string for all other entries.

For more information, see the Atom specification.

is_inserted: boolean

Whether the entry has been inserted on the server. This is %FALSE for entries which have just been created using gdata_entry_new() and %TRUE for entries returned from the server by queries. It is set to %TRUE when an entry is inserted using gdata_service_insert_entry().

parent: any
priv: any
published: number

The date and time the entry was first published or made available.

For more information, see the Atom specification.

rights: string

The ownership rights pertaining to the entry.

For more information, see the Atom specification.

summary: string

A short summary, abstract, or excerpt of the entry.

For more information, see the Atom specification.

title: string

A human-readable title for the entry.

For more information, see the Atom specification.

updated: number

The date and time when the entry was most recently updated significantly.

For more information, see the Atom specification.

name: string

Methods

  • add_author(author: Author): void
  • Adds author to the list of authors in the given #GDataEntry and increments its reference count.

    Duplicate authors will not be added to the list.

    Parameters

    • author: Author

      a #GDataAuthor to add

    Returns void

  • Adds category to the list of categories in the given #GDataEntry, and increments its reference count.

    Duplicate categories will not be added to the list.

    Parameters

    Returns void

  • Adds _link to the list of links in the given #GDataEntry and increments its reference count.

    Duplicate links will not be added to the list.

    Parameters

    Returns void

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • connect(sigName: "notify::content", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::content-uri", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::etag", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::id", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::is-inserted", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::published", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::rights", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::summary", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::title", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::updated", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::content", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::content-uri", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::etag", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::id", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::is-inserted", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::published", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::rights", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::summary", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::title", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::updated", callback: (($obj: Commentable, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Deletes comment from the #GDataCommentable.

    If the given comment isn't deletable (either because the service doesn't support deleting comments at all, or because this particular comment is not deletable due to having insufficient permissions), %GDATA_SERVICE_ERROR_FORBIDDEN will be set in error and %FALSE will be returned.

    Parameters

    • service: GData.Service

      a #GDataService with which the comment will be deleted

    • comment_: GData.Comment

      a comment to be deleted

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Deletes comment from the #GDataCommentable. self, service and comment_ are all reffed when this method is called, so can safely be freed after this method returns.

    For more details, see gdata_commentable_delete_comment(), which is the synchronous version of this method.

    When the operation is finished, callback will be called. You can then call gdata_commentable_delete_comment_finish() to get the results of the operation.

    Parameters

    • service: GData.Service

      a #GDataService with which the comment will be deleted

    • comment_: GData.Comment

      a comment to be deleted

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the operation is finished

    Returns void

  • Finishes an asynchronous comment deletion operation started with gdata_commentable_delete_comment_async().

    Parameters

    Returns boolean

  • disconnect(id: number): void
  • emit(sigName: "notify::content", ...args: any[]): void
  • emit(sigName: "notify::content-uri", ...args: any[]): void
  • emit(sigName: "notify::etag", ...args: any[]): void
  • emit(sigName: "notify::id", ...args: any[]): void
  • emit(sigName: "notify::is-inserted", ...args: any[]): void
  • emit(sigName: "notify::published", ...args: any[]): void
  • emit(sigName: "notify::rights", ...args: any[]): void
  • emit(sigName: "notify::summary", ...args: any[]): void
  • emit(sigName: "notify::title", ...args: any[]): void
  • emit(sigName: "notify::updated", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): 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

  • freeze_notify(): 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

  • get_content(): string
  • Returns the textual content in this entry. If the content in this entry is pointed to by a URI, %NULL will be returned; the content URI will be returned by gdata_entry_get_content_uri().

    Returns string

  • get_content_type(): string
  • get_content_uri(): string
  • Returns a URI pointing to the content of this entry. If the content in this entry is stored directly, %NULL will be returned; the content will be returned by gdata_entry_get_content().

    Returns string

  • get_data(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

  • get_etag(): string
  • Returns the ETag of the entry; a unique identifier for each version of the entry. For more information, see the online documentation.

    The ETag will never be empty; it's either %NULL or a valid ETag.

    Returns string

  • get_id(): string
  • Returns the URN ID of the entry; a unique and permanent identifier for the object the entry represents.

    The ID may be %NULL if and only if the #GDataEntry has been newly created, and hasn't yet been inserted on the server.

    Returns string

  • get_json(): string
  • Builds a JSON representation of the #GDataParsable in its current state, such that it could be inserted on the server. The JSON is valid for stand-alone use.

    Returns string

  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_published(): number
  • get_qdata(quark: number): object
  • get_rights(): string
  • get_summary(): string
  • get_title(): string
  • get_updated(): number
  • get_xml(): string
  • Builds an XML representation of the #GDataParsable in its current state, such that it could be inserted on the server. The XML is guaranteed to have all its namespaces declared properly in a self-contained fashion, and is valid for stand-alone use.

    Returns string

  • 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

  • Adds comment to the #GDataCommentable.

    If the #GDataCommentable doesn't support commenting, %NULL will be returned and error will be set to %GDATA_SERVICE_ERROR_FORBIDDEN.

    Parameters

    • service: GData.Service

      a #GDataService with which the comment will be added

    • comment_: GData.Comment

      a new comment to be added to the #GDataCommentable

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns GData.Comment

  • Adds comment to the #GDataCommentable. self, service and comment_ are all reffed when this method is called, so can safely be freed after this method returns.

    For more details, see gdata_commentable_insert_comment(), which is the synchronous version of this method.

    When the operation is finished, callback will be called. You can then call gdata_commentable_insert_comment_finish() to get the results of the operation.

    Parameters

    • service: GData.Service

      a #GDataService with which the comment will be added

    • comment_: GData.Comment

      a new comment to be added to the #GDataCommentable

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the operation is finished

    Returns void

  • is_floating(): boolean
  • Looks up a link by relation type from the list of links in the entry. If the link has one of the standard Atom relation types, use one of the defined rel values, instead of a static string. e.g. %GDATA_LINK_EDIT or %GDATA_LINK_SELF.

    In the rare event of requiring a list of links with the same rel value, use gdata_entry_look_up_links().

    Parameters

    • rel: string

      the value of the rel attribute of the desired link

    Returns GData.Link

  • Looks up a list of links by relation type from the list of links in the entry. If the links have one of the standard Atom relation types, use one of the defined rel values, instead of a static string. e.g. %GDATA_LINK_EDIT or %GDATA_LINK_SELF.

    If you will only use the first link found, consider calling gdata_entry_look_up_link() instead.

    Parameters

    • rel: string

      the value of the rel attribute of the desired links

    Returns GData.Link[]

  • notify(property_name: 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

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

  • Retrieves a #GDataFeed containing the #GDataComments representing the comments on the #GDataCommentable which match the given query.

    If the #GDataCommentable doesn't support commenting, %NULL will be returned and error will be set to %GDATA_SERVICE_ERROR_FORBIDDEN. This is in contrast to if it does support commenting but hasn't had any comments added yet, in which case an empty #GDataFeed will be returned and no error will be set.

    Parameters

    • service: GData.Service

      a #GDataService representing the service with which the object's comments will be manipulated

    • query: GData.Query

      a #GDataQuery with query parameters, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • progress_callback: QueryProgressCallback

      a #GDataQueryProgressCallback to call when a comment is loaded, or %NULL

    Returns Feed

  • Retrieves a #GDataFeed containing the #GDataComments representing the comments on the #GDataCommentable which match the given query. self, service and query are all reffed when this method is called, so can safely be freed after this method returns.

    For more details, see gdata_commentable_query_comments(), which is the synchronous version of this method.

    When the operation is finished, callback will be called. You can then call gdata_commentable_query_comments_finish() to get the results of the operation.

    Parameters

    • service: GData.Service

      a #GDataService representing the service with which the object's comments will be manipulated

    • query: GData.Query

      a #GDataQuery with query parameters, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • progress_callback: QueryProgressCallback

      a #GDataQueryProgressCallback to call when a comment is loaded, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the query is finished

    Returns void

  • 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

  • Removes _link from the list of links in the given #GDataEntry and decrements its reference count (since the #GDataEntry held a reference to it while it was in the list).

    Parameters

    Returns boolean

  • run_dispose(): 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

  • set_content(content: string): void
  • set_content_uri(content_uri: string): void
  • Sets the URI pointing to the entry's content to content. This unsets #GDataEntry:content.

    Parameters

    • content_uri: string

      the new URI pointing to the content for the entry, or %NULL

    Returns void

  • set_data(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

  • set_property(property_name: string, value?: any): void
  • set_rights(rights: string): void
  • set_summary(summary: string): void
  • set_title(title: string): void
  • steal_data(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

  • steal_qdata(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

  • thaw_notify(): 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_insert_comment_uri(comment: GData.Comment): string
  • vfunc_get_namespaces(namespaces: HashTable<string | number | symbol, string | number | boolean>): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_get_query_comments_uri(): string
  • 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.

    virtual

    Parameters

    Returns void

  • vfunc_parse_json(reader: Reader): boolean
  • vfunc_post_parse_json(): boolean
  • vfunc_post_parse_xml(): boolean
  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(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

  • compat_control(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

    • g_iface: TypeInterface

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

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

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

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • 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

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