Class BookmarkFile

An opaque data structure representing a set of bookmarks.

record

Hierarchy

BookmarkFile

Constructors

constructor

new BookmarkFile(): BookmarkFile

Returns BookmarkFile

Properties

Static name

name: string

Methods

add_application

add_application(uri: string, name: string, exec: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12250
Adds the application with name and exec to the list of applications that have registered a bookmark for uri into bookmark.

Every bookmark inside a #GBookmarkFile must have at least an application registered. Each application must provide a name, a command line useful for launching the bookmark, the number of times the bookmark has been registered by the application and the last time the application registered this bookmark.

If name is %NULL, the name of the application will be the same returned by g_get_application_name(); if exec is %NULL, the command line will be a composition of the program name as returned by g_get_prgname() and the "%u" modifier, which will be expanded to the bookmark's URI.

This function will automatically take care of updating the registrations count and timestamping in case an application with the same name had already registered a bookmark for uri inside bookmark.

If no bookmark for uri is found, one is created.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  the name of the application registering the bookmark or %NULL
- exec: string
  
  command line to be used to launch the bookmark or %NULL
Returns void

add_group

add_group(uri: string, group: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12259
Adds group to the list of groups to which the bookmark for uri belongs to.

If no bookmark for uri is found then it is created.

Parameters
- uri: string
  
  a valid URI
- group: string
  
  the group name to be added
Returns void

free

free(): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12263
Frees a #GBookmarkFile.

Returns void

get_added

get_added(uri: string): number

- Defined in @types/Gjs/GLib-2.0.d.ts:12271
Gets the time the bookmark for uri was added to bookmark

In the event the URI cannot be found, -1 is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns number

get_added_date_time

get_added_date_time(uri: string): GLib.DateTime

- Defined in @types/Gjs/GLib-2.0.d.ts:12279
Gets the time the bookmark for uri was added to bookmark

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns GLib.DateTime

get_app_info

get_app_info(uri: string, name: string): [boolean, string, number, number]

- Defined in @types/Gjs/GLib-2.0.d.ts:12297
Gets the registration information of app_name for the bookmark for uri. See g_bookmark_file_set_application_info() for more information about the returned data.

The string returned in app_exec must be freed.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name app_name has registered a bookmark for uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting the command line fails, an error of the %G_SHELL_ERROR domain is set and %FALSE is returned.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  an application's name
Returns [boolean, string, number, number]

get_application_info

get_application_info(uri: string, name: string): [boolean, string, number, GLib.DateTime]

- Defined in @types/Gjs/GLib-2.0.d.ts:12315
Gets the registration information of app_name for the bookmark for uri. See g_bookmark_file_set_application_info() for more information about the returned data.

The string returned in app_exec must be freed.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name app_name has registered a bookmark for uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting the command line fails, an error of the %G_SHELL_ERROR domain is set and %FALSE is returned.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  an application's name
Returns [boolean, string, number, GLib.DateTime]

get_applications

get_applications(uri: string): string[]

- Defined in @types/Gjs/GLib-2.0.d.ts:12324
Retrieves the names of the applications that have registered the bookmark for uri.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns string[]

get_description

get_description(uri: string): string

- Defined in @types/Gjs/GLib-2.0.d.ts:12332
Retrieves the description of the bookmark for uri.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns string

get_groups

get_groups(uri: string): string[]

- Defined in @types/Gjs/GLib-2.0.d.ts:12343
Retrieves the list of group names of the bookmark for uri.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

The returned array is %NULL terminated, so length may optionally be %NULL.

Parameters
- uri: string
  
  a valid URI
Returns string[]

get_icon

get_icon(uri: string): [boolean, string, string]

- Defined in @types/Gjs/GLib-2.0.d.ts:12351
Gets the icon of the bookmark for uri.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns [boolean, string, string]

get_is_private

get_is_private(uri: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12361
Gets whether the private flag of the bookmark for uri is set.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that the private flag cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Parameters
- uri: string
  
  a valid URI
Returns boolean

get_mime_type

get_mime_type(uri: string): string

- Defined in @types/Gjs/GLib-2.0.d.ts:12371
Retrieves the MIME type of the resource pointed by uri.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that the MIME type cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Parameters
- uri: string
  
  a valid URI
Returns string

get_modified

get_modified(uri: string): number

- Defined in @types/Gjs/GLib-2.0.d.ts:12379
Gets the time when the bookmark for uri was last modified.

In the event the URI cannot be found, -1 is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns number

get_modified_date_time

get_modified_date_time(uri: string): GLib.DateTime

- Defined in @types/Gjs/GLib-2.0.d.ts:12387
Gets the time when the bookmark for uri was last modified.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns GLib.DateTime

get_size

get_size(): number

- Defined in @types/Gjs/GLib-2.0.d.ts:12391
Gets the number of bookmarks inside bookmark.

Returns number

get_title

get_title(uri: string): string

- Defined in @types/Gjs/GLib-2.0.d.ts:12401
Returns the title of the bookmark for uri.

If uri is %NULL, the title of bookmark is returned.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI or %NULL
Returns string

get_uris

get_uris(): string[]

- Defined in @types/Gjs/GLib-2.0.d.ts:12407
Returns all URIs of the bookmarks in the bookmark file bookmark. The array of returned URIs will be %NULL-terminated, so length may optionally be %NULL.

Returns string[]

get_visited

get_visited(uri: string): number

- Defined in @types/Gjs/GLib-2.0.d.ts:12415
Gets the time the bookmark for uri was last visited.

In the event the URI cannot be found, -1 is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns number

get_visited_date_time

get_visited_date_time(uri: string): GLib.DateTime

- Defined in @types/Gjs/GLib-2.0.d.ts:12423
Gets the time the bookmark for uri was last visited.

In the event the URI cannot be found, %NULL is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
Returns GLib.DateTime

has_application

has_application(uri: string, name: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12433
Checks whether the bookmark for uri inside bookmark has been registered by application name.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  the name of the application
Returns boolean

has_group

has_group(uri: string, group: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12443
Checks whether group appears in the list of groups to which the bookmark for uri belongs to.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- uri: string
  
  a valid URI
- group: string
  
  the group name to be searched
Returns boolean

has_item

has_item(uri: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12448
Looks whether the desktop bookmark has an item with its URI set to uri.

Parameters
- uri: string
  
  a valid URI
Returns boolean

load_from_data

load_from_data(data: Uint8Array): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12455
Loads a bookmark file from memory into an empty #GBookmarkFile structure. If the object cannot be created then error is set to a #GBookmarkFileError.

Parameters
- data: Uint8Array
  
  desktop bookmarks loaded in memory
Returns boolean

load_from_data_dirs

load_from_data_dirs(file: string): [boolean, string]

- Defined in @types/Gjs/GLib-2.0.d.ts:12464
This function looks for a desktop bookmark file named file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into bookmark and returns the file's full path in full_path. If the file could not be loaded then error is set to either a #GFileError or #GBookmarkFileError.

Parameters
- file: string
  
  a relative path to a filename to open and parse
Returns [boolean, string]

load_from_file

load_from_file(filename: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12471
Loads a desktop bookmark file into an empty #GBookmarkFile structure. If the file could not be loaded then error is set to either a #GFileError or #GBookmarkFileError.

Parameters
- filename: string
  
  the path of a filename to load, in the GLib file name encoding
Returns boolean

move_item

move_item(old_uri: string, new_uri: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12482
Changes the URI of a bookmark item from old_uri to new_uri. Any existing bookmark for new_uri will be overwritten. If new_uri is %NULL, then the bookmark is removed.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

Parameters
- old_uri: string
  
  a valid URI
- new_uri: string
  
  a valid URI, or %NULL
Returns boolean

remove_application

remove_application(uri: string, name: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12495
Removes application registered with name from the list of applications that have registered a bookmark for uri inside bookmark.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name app_name has registered a bookmark for uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  the name of the application
Returns boolean

remove_group

remove_group(uri: string, group: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12507
Removes group from the list of groups to which the bookmark for uri belongs to.

In the event the URI cannot be found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event no group was defined, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

Parameters
- uri: string
  
  a valid URI
- group: string
  
  the group name to be removed
Returns boolean

remove_item

remove_item(uri: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12512
Removes the bookmark for uri from the bookmark file bookmark.

Parameters
- uri: string
  
  a valid URI
Returns boolean

set_added

set_added(uri: string, added: number): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12520
Sets the time the bookmark for uri was added into bookmark.

If no bookmark for uri is found then it is created.

Parameters
- uri: string
  
  a valid URI
- added: number
  
  a timestamp or -1 to use the current time
Returns void

set_added_date_time

set_added_date_time(uri: string, added: GLib.DateTime): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12528
Sets the time the bookmark for uri was added into bookmark.

If no bookmark for uri is found then it is created.

Parameters
- uri: string
  
  a valid URI
- added: GLib.DateTime
  
  a #GDateTime
Returns void

set_app_info

set_app_info(uri: string, name: string, exec: string, count: number, stamp: number): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12564
Sets the meta-data of application name inside the list of applications that have registered a bookmark for uri inside bookmark.

You should rarely use this function; use g_bookmark_file_add_application() and g_bookmark_file_remove_application() instead.

name can be any UTF-8 encoded string used to identify an application. exec can have one of these two modifiers: "%f", which will be expanded as the local file name retrieved from the bookmark's URI; "%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the g_bookmark_file_get_application_info() function. count is the number of times the application has registered the bookmark; if is < 0, the current registration count will be increased by one, if is 0, the application with name will be removed from the list of registered applications. stamp is the Unix time of the last registration; if it is -1, the current time will be used.

If you try to remove an application by setting its registration count to zero, and no bookmark for uri is found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly, in the event that no application name has registered a bookmark for uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark for uri is found, one is created.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  an application's name
- exec: string
  
  an application's command line
- count: number
  
  the number of registrations done for this application
- stamp: number
  
  the time of the last registration for this application
Returns boolean

set_application_info

set_application_info(uri: string, name: string, exec: string, count: number, stamp: GLib.DateTime): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12599
Sets the meta-data of application name inside the list of applications that have registered a bookmark for uri inside bookmark.

You should rarely use this function; use g_bookmark_file_add_application() and g_bookmark_file_remove_application() instead.

name can be any UTF-8 encoded string used to identify an application. exec can have one of these two modifiers: "%f", which will be expanded as the local file name retrieved from the bookmark's URI; "%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the g_bookmark_file_get_application_info() function. count is the number of times the application has registered the bookmark; if is < 0, the current registration count will be increased by one, if is 0, the application with name will be removed from the list of registered applications. stamp is the Unix time of the last registration.

If you try to remove an application by setting its registration count to zero, and no bookmark for uri is found, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly, in the event that no application name has registered a bookmark for uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark for uri is found, one is created.

Parameters
- uri: string
  
  a valid URI
- name: string
  
  an application's name
- exec: string
  
  an application's command line
- count: number
  
  the number of registrations done for this application
- stamp: GLib.DateTime
  
  the time of the last registration for this application, which may be %NULL if count is 0
Returns boolean

set_description

set_description(uri: string, description: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12609
Sets description as the description of the bookmark for uri.

If uri is %NULL, the description of bookmark is set.

If a bookmark for uri cannot be found then it is created.

Parameters
- uri: string
  
  a valid URI or %NULL
- description: string
  
  a string
Returns void

set_groups

set_groups(uri: string, groups: string[]): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12618
Sets a list of group names for the item with URI uri. Each previously set group name list is removed.

If uri cannot be found then an item for it is created.

Parameters
- uri: string
  
  an item's URI
- groups: string[]
  
  an array of group names, or %NULL to remove all groups
Returns void

set_icon

set_icon(uri: string, href: string, mime_type: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12629
Sets the icon for the bookmark for uri. If href is %NULL, unsets the currently set icon. href can either be a full URL for the icon file or the icon name following the Icon Naming specification.

If no bookmark for uri is found one is created.

Parameters
- uri: string
  
  a valid URI
- href: string
  
  the URI of the icon for the bookmark, or %NULL
- mime_type: string
  
  the MIME type of the icon for the bookmark
Returns void

set_is_private

set_is_private(uri: string, is_private: boolean): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12637
Sets the private flag of the bookmark for uri.

If a bookmark for uri cannot be found then it is created.

Parameters
- uri: string
  
  a valid URI
- is_private: boolean
  
  %TRUE if the bookmark should be marked as private
Returns void

set_mime_type

set_mime_type(uri: string, mime_type: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12645
Sets mime_type as the MIME type of the bookmark for uri.

If a bookmark for uri cannot be found then it is created.

Parameters
- uri: string
  
  a valid URI
- mime_type: string
  
  a MIME type
Returns void

set_modified

set_modified(uri: string, modified: number): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12658
Sets the last time the bookmark for uri was last modified.

If no bookmark for uri is found then it is created.

The "modified" time should only be set when the bookmark's meta-data was actually changed. Every function of #GBookmarkFile that modifies a bookmark also changes the modification time, except for g_bookmark_file_set_visited_date_time().

Parameters
- uri: string
  
  a valid URI
- modified: number
  
  a timestamp or -1 to use the current time
Returns void

set_modified_date_time

set_modified_date_time(uri: string, modified: GLib.DateTime): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12671
Sets the last time the bookmark for uri was last modified.

If no bookmark for uri is found then it is created.

The "modified" time should only be set when the bookmark's meta-data was actually changed. Every function of #GBookmarkFile that modifies a bookmark also changes the modification time, except for g_bookmark_file_set_visited_date_time().

Parameters
- uri: string
  
  a valid URI
- modified: GLib.DateTime
  
  a #GDateTime
Returns void

set_title

set_title(uri: string, title: string): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12682
Sets title as the title of the bookmark for uri inside the bookmark file bookmark.

If uri is %NULL, the title of bookmark is set.

If a bookmark for uri cannot be found then it is created.

Parameters
- uri: string
  
  a valid URI or %NULL
- title: string
  
  a UTF-8 encoded string
Returns void

set_visited

set_visited(uri: string, visited: number): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12696
Sets the time the bookmark for uri was last visited.

If no bookmark for uri is found then it is created.

The "visited" time should only be set if the bookmark was launched, either using the command line retrieved by g_bookmark_file_get_application_info() or by the default application for the bookmark's MIME type, retrieved using g_bookmark_file_get_mime_type(). Changing the "visited" time does not affect the "modified" time.

Parameters
- uri: string
  
  a valid URI
- visited: number
  
  a timestamp or -1 to use the current time
Returns void

set_visited_date_time

set_visited_date_time(uri: string, visited: GLib.DateTime): void

- Defined in @types/Gjs/GLib-2.0.d.ts:12710
Sets the time the bookmark for uri was last visited.

If no bookmark for uri is found then it is created.

The "visited" time should only be set if the bookmark was launched, either using the command line retrieved by g_bookmark_file_get_application_info() or by the default application for the bookmark's MIME type, retrieved using g_bookmark_file_get_mime_type(). Changing the "visited" time does not affect the "modified" time.

Parameters
- uri: string
  
  a valid URI
- visited: GLib.DateTime
  
  a #GDateTime
Returns void

to_data

to_data(): Uint8Array

- Defined in @types/Gjs/GLib-2.0.d.ts:12714
This function outputs bookmark as a string.

Returns Uint8Array

to_file

to_file(filename: string): boolean

- Defined in @types/Gjs/GLib-2.0.d.ts:12720
This function outputs bookmark into a file. The write process is guaranteed to be atomic by using g_file_set_contents() internally.

Parameters
- filename: string
  
  path of the output file
Returns boolean

Static error_quark

error_quark(): number

- Defined in @types/Gjs/GLib-2.0.d.ts:12735
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BookmarkFile

Properties

Static name

Methods

add_application

Parameters

uri: string

name: string

exec: string

Returns void

add_group

Parameters

uri: string

group: string

Returns void

free

Returns void

get_added

Parameters

uri: string

Returns number

get_added_date_time

Parameters

uri: string

Returns GLib.DateTime

get_app_info

Parameters

uri: string

name: string

Returns [boolean, string, number, number]

get_application_info

Parameters

uri: string

name: string

Returns [boolean, string, number, GLib.DateTime]

get_applications

Parameters

uri: string

Returns string[]

get_description

Parameters

uri: string

Returns string

get_groups

Parameters

uri: string

Returns string[]

get_icon

Parameters

uri: string

Returns [boolean, string, string]

get_is_private

Parameters

uri: string

Returns boolean

get_mime_type

Parameters

uri: string

Returns string

get_modified

Parameters

uri: string

Returns number

get_modified_date_time

Parameters

uri: string

Returns GLib.DateTime

get_size

Returns number

get_title

Parameters

uri: string

Returns string