Service
Object Hierarchy:
Description:
public class Service :
Object
The class structure for the Service type.
Namespace: GData
Package: libgdata
Content:
Properties:
-
public bool authenticated { get; }
-
public string client_id { construct set; get; }
-
public string locale { set; get; }
The locale to use for network requests, in Unix locale format. (e.g. "en_GB", "cs", "de_DE".) Use
null for the default "C" locale (typically "en_US").
-
public string password { get; }
-
public URI proxy_uri { set; get; }
The proxy URI used internally for all network requests.
-
public uint timeout { set; get; }
A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be
cancelled and NETWORK_ERROR will be returned.
-
public string username { get; }
Creation methods:
Methods:
-
public virtual void append_query_headers (Message message)
-
public bool authenticate (string username, string password, Cancellable? cancellable) throws Error
-
public async bool authenticate_async (string username, string password, Cancellable? cancellable) throws Error
-
public bool delete_entry (Entry entry, Cancellable? cancellable) throws Error
Deletes entry from the server. For more information about the concept of deleting
entries, see the online documentation for the GData protocol.
-
public async bool delete_entry_async (Entry entry, Cancellable? cancellable) throws Error
Deletes entry from the server. self and entry are both reffed
when this function is called, so can safely be unreffed after this function returns.
-
public unowned string get_client_id ()
-
public unowned string get_locale ()
Returns the locale currently being used for network requests, or null if the locale is
the default.
-
public unowned string get_password ()
-
public unowned URI get_proxy_uri ()
-
public uint get_timeout ()
Gets the timeout property; the network
timeout, in seconds.
-
public unowned string get_username ()
-
public Entry insert_entry (string upload_uri, Entry entry, Cancellable? cancellable) throws Error
Inserts entry by uploading it to the online service at upload_uri. For
more information about the concept of inserting entries, see the online documentation for the GData protocol.
-
public async Entry insert_entry_async (string upload_uri, Entry entry, Cancellable? cancellable) throws Error
Inserts entry by uploading it to the online service at upload_uri.
self, upload_uri and entry are all reffed/copied when this function is called, so can safely be
freed after this function returns.
-
public bool is_authenticated ()
-
public virtual bool parse_authentication_response (uint status, string response_body, int length) throws Error
-
public virtual void parse_error_response (OperationType operation_type, uint status, string reason_phrase, string response_body, int length) throws Error
-
public Feed query (string feed_uri, Query? query, Type entry_type, Cancellable? cancellable, QueryProgressCallback progress_callback) throws Error
Queries the service's feed_uri feed to build a
Feed.
-
public async Feed query_async (string feed_uri, Query? query, Type entry_type, Cancellable? cancellable, QueryProgressCallback progress_callback) throws Error
Queries the service's feed_uri feed to build a
Feed. self, feed_uri and query are all reffed/copied when this function is called, so
can safely be freed after this function returns.
-
public Entry query_single_entry (string entry_id, Query? query, Type entry_type, Cancellable? cancellable) throws Error
Retrieves information about the single entry with the given entry_id. entry_id
should be as returned by get_id.
-
public async Entry query_single_entry_async (string entry_id, Query? query, Type entry_type, Cancellable? cancellable) throws Error
Retrieves information about the single entry with the given entry_id. entry_id
should be as returned by get_id. self, query
and entry_id are reffed/copied when this function is called, so can safely be freed after this function
returns.
-
public void set_locale (string? locale)
Set the locale used for network requests to locale, given in standard Unix locale
format. See locale for more details.
-
public void set_proxy_uri (URI? proxy_uri)
Sets the proxy URI on the Session
used internally by the given Service. This forces all requests through the
given proxy.
-
public void set_timeout (uint timeout)
Sets the timeout property; the network
timeout, in seconds.
-
public Entry update_entry (Entry entry, Cancellable? cancellable) throws Error
Updates entry by PUTting it to its edit link's URI. For more information about
the concept of updating entries, see the online documentation for the GData protocol.
-
public async Entry update_entry_async (Entry entry, Cancellable? cancellable) throws Error
Updates entry by PUTting it to its edit link's URI. self and
entry are both reffed when this function is called, so can safely be unreffed after this function returns.
Signals: