|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataUploadStream: GData Reference Manual</title>
|
|
Packit |
4b6dd7 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
4b6dd7 |
<link rel="home" href="index.html" title="GData Reference Manual">
|
|
Packit |
4b6dd7 |
<link rel="up" href="ch02.html" title="Core API">
|
|
Packit |
4b6dd7 |
<link rel="prev" href="GDataDownloadStream.html" title="GDataDownloadStream">
|
|
Packit |
4b6dd7 |
<link rel="next" href="GDataComparable.html" title="GDataComparable">
|
|
Packit |
4b6dd7 |
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
|
|
Packit |
4b6dd7 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
4b6dd7 |
</head>
|
|
Packit |
4b6dd7 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Top |
|
|
Packit |
4b6dd7 |
Description |
|
|
Packit |
4b6dd7 |
Object Hierarchy |
|
|
Packit |
4b6dd7 |
Properties
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataUploadStream
|
|
Packit |
4b6dd7 |
GDataUploadStream — GData upload stream object
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Stability Level
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
develop applications to these interfaces, release them, and have confidence that
|
|
Packit |
4b6dd7 |
they will run on all minor releases of the product (after the one in which the
|
|
Packit |
4b6dd7 |
interface was introduced, and within the same major release). Even at a major
|
|
Packit |
4b6dd7 |
release, incompatible changes are expected to be rare, and to have strong
|
|
Packit |
4b6dd7 |
justifications.
|
|
Packit |
4b6dd7 |
">Stable, unless otherwise indicated
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GOutputStream *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GOutputStream *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new_resumable ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_response ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataService *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_service ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_authorization_domain ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GCancellable *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_cancellable ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_method ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_upload_uri ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataEntry *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_entry ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_slug ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_type ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
goffset
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_length ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Properties
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *
|
|
Packit |
4b6dd7 |
authorization-domain
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GCancellable *
|
|
Packit |
4b6dd7 |
cancellable
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
content-length
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
content-type
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataEntry *
|
|
Packit |
4b6dd7 |
entry
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
method
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataService *
|
|
Packit |
4b6dd7 |
service
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
slug
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
upload-uri
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_LINK_RESUMABLE_CREATE_MEDIA
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_LINK_RESUMABLE_EDIT_MEDIA
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataUploadStreamClass
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GObject
|
|
Packit |
4b6dd7 |
╰── GOutputStream
|
|
Packit |
4b6dd7 |
╰── GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-upload-stream.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataUploadStream is a GOutputStream subclass to allow uploading of files from GData services with authorization from a GDataService under
|
|
Packit |
4b6dd7 |
the given GDataAuthorizationDomain. If authorization is not required to perform the upload, a GDataAuthorizationDomain doesn't have to be
|
|
Packit |
4b6dd7 |
specified.
|
|
Packit |
4b6dd7 |
Once a GDataUploadStream is instantiated with gdata_upload_stream_new(), the standard GOutputStream API can be used on the stream to upload
|
|
Packit |
4b6dd7 |
the file. Network communication may not actually begin until the first call to g_output_stream_write(), so having a GDataUploadStream around is no
|
|
Packit |
4b6dd7 |
guarantee that data is being uploaded.
|
|
Packit |
4b6dd7 |
Uploads of a file, or a file with associated metadata (a GDataEntry) should use GDataUploadStream, but if you want to simply upload a single
|
|
Packit |
4b6dd7 |
GDataEntry, use gdata_service_insert_entry() instead. GDataUploadStream is for large streaming uploads.
|
|
Packit |
4b6dd7 |
Once an upload is complete, the server's response can be retrieved from the GDataUploadStream using gdata_upload_stream_get_response(). In order
|
|
Packit |
4b6dd7 |
for network communication to be guaranteed to have stopped (and thus the response definitely available), g_output_stream_close() must be called
|
|
Packit |
4b6dd7 |
on the GDataUploadStream first. Otherwise, gdata_upload_stream_get_response() may return saying that the operation is still in progress.
|
|
Packit |
4b6dd7 |
If the server returns an error instead of a success response, the error will be returned by g_output_stream_close() as a GDataServiceError.
|
|
Packit |
4b6dd7 |
The entire upload operation can be cancelled using the GCancellable instance provided to gdata_upload_stream_new(), or returned by
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_cancellable(). Cancelling this at any time will cause all future GOutputStream method calls to return
|
|
Packit |
4b6dd7 |
G_IO_ERROR_CANCELLED. If any GOutputStream methods are in the process of being called, they will be cancelled and return G_IO_ERROR_CANCELLED as
|
|
Packit |
4b6dd7 |
soon as possible.
|
|
Packit |
4b6dd7 |
Note that cancelling an individual method call (such as a call to g_output_stream_write()) using the GCancellable parameter of the method will not
|
|
Packit |
4b6dd7 |
cancel the upload as a whole — just that particular method call. In the case of g_output_stream_write(), this will cause it to return the number of
|
|
Packit |
4b6dd7 |
bytes it has successfully written up to the point of cancellation (up to the requested number of bytes), or return a G_IO_ERROR_CANCELLED if it
|
|
Packit |
4b6dd7 |
had not managed to write any bytes to the network by that point. This is also the behaviour of g_output_stream_write() when the upload operation as
|
|
Packit |
4b6dd7 |
a whole is cancelled.
|
|
Packit |
4b6dd7 |
In the case of g_output_stream_close(), the call will return immediately if network activity hasn't yet started. If it has, the network activity
|
|
Packit |
4b6dd7 |
will be cancelled, regardless of whether the call to g_output_stream_close() is cancelled. Cancelling a pending call to g_output_stream_close()
|
|
Packit |
4b6dd7 |
(either using the method's GCancellable, or by cancelling the upload stream as a whole) will cause it to stop waiting for the network activity to
|
|
Packit |
4b6dd7 |
finish, and return G_IO_ERROR_CANCELLED immediately. Network activity will continue to be shut down in the background.
|
|
Packit |
4b6dd7 |
Any outstanding data is guaranteed to be written to the network successfully even if a call to g_output_stream_close() is cancelled. However, if
|
|
Packit |
4b6dd7 |
the upload stream as a whole is cancelled using “cancellable”, no more data will be sent over the network, and the network
|
|
Packit |
4b6dd7 |
connection will be closed immediately. i.e. GDataUploadStream will do its best to instruct the server to cancel the upload and any associated
|
|
Packit |
4b6dd7 |
server-side changes of state.
|
|
Packit |
4b6dd7 |
If the server returns an error message (for example, if the user is not correctly authenticated/authorized or doesn't have suitable permissions
|
|
Packit |
4b6dd7 |
to upload from the given URI), it will be returned as a GDataServiceError by g_output_stream_close().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Example 3. Uploading from a File
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
1
|
|
Packit |
4b6dd7 |
2
|
|
Packit |
4b6dd7 |
3
|
|
Packit |
4b6dd7 |
4
|
|
Packit |
4b6dd7 |
5
|
|
Packit |
4b6dd7 |
6
|
|
Packit |
4b6dd7 |
7
|
|
Packit |
4b6dd7 |
8
|
|
Packit |
4b6dd7 |
9
|
|
Packit |
4b6dd7 |
10
|
|
Packit |
4b6dd7 |
11
|
|
Packit |
4b6dd7 |
12
|
|
Packit |
4b6dd7 |
13
|
|
Packit |
4b6dd7 |
14
|
|
Packit |
4b6dd7 |
15
|
|
Packit |
4b6dd7 |
16
|
|
Packit |
4b6dd7 |
17
|
|
Packit |
4b6dd7 |
18
|
|
Packit |
4b6dd7 |
19
|
|
Packit |
4b6dd7 |
20
|
|
Packit |
4b6dd7 |
21
|
|
Packit |
4b6dd7 |
22
|
|
Packit |
4b6dd7 |
23
|
|
Packit |
4b6dd7 |
24
|
|
Packit |
4b6dd7 |
25
|
|
Packit |
4b6dd7 |
26
|
|
Packit |
4b6dd7 |
27
|
|
Packit |
4b6dd7 |
28
|
|
Packit |
4b6dd7 |
29
|
|
Packit |
4b6dd7 |
30
|
|
Packit |
4b6dd7 |
31
|
|
Packit |
4b6dd7 |
32
|
|
Packit |
4b6dd7 |
33
|
|
Packit |
4b6dd7 |
34
|
|
Packit |
4b6dd7 |
35
|
|
Packit |
4b6dd7 |
36
|
|
Packit |
4b6dd7 |
37
|
|
Packit |
4b6dd7 |
38
|
|
Packit |
4b6dd7 |
39
|
|
Packit |
4b6dd7 |
40
|
|
Packit |
4b6dd7 |
41
|
|
Packit |
4b6dd7 |
42
|
|
Packit |
4b6dd7 |
43
|
|
Packit |
4b6dd7 |
44
|
|
Packit |
4b6dd7 |
45
|
|
Packit |
4b6dd7 |
46
|
|
Packit |
4b6dd7 |
47
|
|
Packit |
4b6dd7 |
48
|
|
Packit |
4b6dd7 |
49
|
|
Packit |
4b6dd7 |
50
|
|
Packit |
4b6dd7 |
51
|
|
Packit |
4b6dd7 |
52
|
|
Packit |
4b6dd7 |
53
|
|
Packit |
4b6dd7 |
54
|
|
Packit |
4b6dd7 |
55
|
|
Packit |
4b6dd7 |
56
|
|
Packit |
4b6dd7 |
57
|
|
Packit |
4b6dd7 |
58
|
|
Packit |
4b6dd7 |
59
|
|
Packit |
4b6dd7 |
60
|
|
Packit |
4b6dd7 |
61
|
|
Packit |
4b6dd7 |
62
|
|
Packit |
4b6dd7 |
63
|
|
Packit |
4b6dd7 |
64
|
|
Packit |
4b6dd7 |
65
|
|
Packit |
4b6dd7 |
66
|
|
Packit |
4b6dd7 |
67
|
|
Packit |
4b6dd7 |
68
|
|
Packit |
4b6dd7 |
69
|
|
Packit |
4b6dd7 |
70
|
|
Packit |
4b6dd7 |
71
|
|
Packit |
4b6dd7 |
GDataService *service;
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain;
|
|
Packit |
4b6dd7 |
GCancellable *cancellable;
|
|
Packit |
4b6dd7 |
GInputStream *input_stream;
|
|
Packit |
4b6dd7 |
GOutputStream *upload_stream;
|
|
Packit |
4b6dd7 |
GFile *file;
|
|
Packit |
4b6dd7 |
GFileInfo *file_info;
|
|
Packit |
4b6dd7 |
GError *error = NULL;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
file = get_file_to_upload ();
|
|
Packit |
4b6dd7 |
file_info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME "," G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE ","
|
|
Packit |
4b6dd7 |
G_FILE_ATTRIBUTE_STANDARD_SIZE,
|
|
Packit |
4b6dd7 |
G_FILE_QUERY_INFO_NONE, NULL, &error);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (file_info == NULL) {
|
|
Packit |
4b6dd7 |
g_error ("Error getting file info: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
g_object_unref (file);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
input_stream = g_file_read (file, NULL, &error);
|
|
Packit |
4b6dd7 |
g_object_unref (file);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (input_stream == NULL) {
|
|
Packit |
4b6dd7 |
g_error ("Error getting file input stream: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
g_object_unref (file_info);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service = create_my_service ();
|
|
Packit |
4b6dd7 |
domain = get_my_authorization_domain_from_service (service);
|
|
Packit |
4b6dd7 |
cancellable = g_cancellable_new ();
|
|
Packit |
4b6dd7 |
upload_stream = gdata_upload_stream_new_resumable (service, domain, SOUP_METHOD_POST, upload_uri, NULL,
|
|
Packit |
4b6dd7 |
g_file_info_get_display_name (file_info), g_file_info_get_content_type (file_info),
|
|
Packit |
4b6dd7 |
g_file_info_get_size (file_info), cancellable);
|
|
Packit |
4b6dd7 |
g_object_unref (file_info);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_output_stream_splice_async (upload_stream, input_stream, G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE | G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
|
|
Packit |
4b6dd7 |
G_PRIORITY_DEFAULT, NULL, (GAsyncReadyCallback) upload_splice_cb, NULL);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (upload_stream);
|
|
Packit |
4b6dd7 |
g_object_unref (input_stream);
|
|
Packit |
4b6dd7 |
g_object_unref (cancellable);
|
|
Packit |
4b6dd7 |
g_object_unref (domain);
|
|
Packit |
4b6dd7 |
g_object_unref (service);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
static void
|
|
Packit |
4b6dd7 |
upload_splice_cb (GOutputStream *upload_stream, GAsyncResult *result, gpointer user_data)
|
|
Packit |
4b6dd7 |
{
|
|
Packit |
4b6dd7 |
gssize length;
|
|
Packit |
4b6dd7 |
GError *error = NULL;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_output_stream_splice_finish (upload_stream, result, &error);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (error != NULL && g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED) == FALSE)) {
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_error ("Error uploading file: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
parse_server_result (gdata_upload_stream_get_response (GDATA_UPLOAD_STREAM (upload_stream), &length), length);
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new ()
|
|
Packit |
4b6dd7 |
GOutputStream *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new (GDataService *service,
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain,
|
|
Packit |
4b6dd7 |
const gchar *method,
|
|
Packit |
4b6dd7 |
const gchar *upload_uri,
|
|
Packit |
4b6dd7 |
GDataEntry *entry,
|
|
Packit |
4b6dd7 |
const gchar *slug,
|
|
Packit |
4b6dd7 |
const gchar *content_type,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable);
|
|
Packit |
4b6dd7 |
Creates a new GDataUploadStream, allowing a file to be uploaded from a GData service using standard GOutputStream API.
|
|
Packit |
4b6dd7 |
The HTTP method to use should be specified in method
|
|
Packit |
4b6dd7 |
, and will typically be either SOUP_METHOD_POST (for insertions) or SOUP_METHOD_PUT
|
|
Packit |
4b6dd7 |
(for updates), according to the server and the upload_uri
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
If entry
|
|
Packit |
4b6dd7 |
is specified, it will be attached to the upload as the entry to which the file being uploaded belongs. Otherwise, just the file
|
|
Packit |
4b6dd7 |
written to the stream will be uploaded, and given a default entry as determined by the server.
|
|
Packit |
4b6dd7 |
slug
|
|
Packit |
4b6dd7 |
and content_type
|
|
Packit |
4b6dd7 |
must be specified before the upload begins, as they describe the file being streamed. slug
|
|
Packit |
4b6dd7 |
is the filename given to the
|
|
Packit |
4b6dd7 |
file, which will typically be stored on the server and made available when downloading the file again. content_type
|
|
Packit |
4b6dd7 |
must be the correct
|
|
Packit |
4b6dd7 |
content type for the file, and should be in the service's list of acceptable content types.
|
|
Packit |
4b6dd7 |
As well as the standard GIO errors, calls to the GOutputStream API on a GDataUploadStream can also return any relevant specific error from
|
|
Packit |
4b6dd7 |
GDataServiceError, or GDATA_SERVICE_ERROR_PROTOCOL_ERROR in the general case.
|
|
Packit |
4b6dd7 |
If a GCancellable is provided in cancellable
|
|
Packit |
4b6dd7 |
, the upload operation may be cancelled at any time from another thread using g_cancellable_cancel().
|
|
Packit |
4b6dd7 |
In this case, any ongoing network activity will be stopped, and any pending or future calls to GOutputStream API on the GDataUploadStream will
|
|
Packit |
4b6dd7 |
return G_IO_ERROR_CANCELLED. Note that the GCancellable objects which can be passed to individual GOutputStream operations will not cancel the
|
|
Packit |
4b6dd7 |
upload operation proper if cancelled — they will merely cancel that API call. The only way to cancel the upload operation completely is using this
|
|
Packit |
4b6dd7 |
cancellable
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
Note that network communication won't begin until the first call to g_output_stream_write() on the GDataUploadStream.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service
|
|
Packit |
4b6dd7 |
a GDataService
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
domain
|
|
Packit |
4b6dd7 |
the GDataAuthorizationDomain to authorize the upload, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
method
|
|
Packit |
4b6dd7 |
the HTTP method to use
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
upload_uri
|
|
Packit |
4b6dd7 |
the URI to upload, which must be HTTPS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
entry
|
|
Packit |
4b6dd7 |
the entry to upload as metadata, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
slug
|
|
Packit |
4b6dd7 |
the file's slug (filename)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
content_type
|
|
Packit |
4b6dd7 |
the content type of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
cancellable
|
|
Packit |
4b6dd7 |
a GCancellable for the entire upload stream, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GOutputStream, or NULL; unref with g_object_unref()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new_resumable ()
|
|
Packit |
4b6dd7 |
GOutputStream *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new_resumable (GDataService *service,
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain,
|
|
Packit |
4b6dd7 |
const gchar *method,
|
|
Packit |
4b6dd7 |
const gchar *upload_uri,
|
|
Packit |
4b6dd7 |
GDataEntry *entry,
|
|
Packit |
4b6dd7 |
const gchar *slug,
|
|
Packit |
4b6dd7 |
const gchar *content_type,
|
|
Packit |
4b6dd7 |
goffset content_length,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable);
|
|
Packit |
4b6dd7 |
Creates a new resumable GDataUploadStream, allowing a file to be uploaded from a GData service using standard GOutputStream API. The upload will
|
|
Packit |
4b6dd7 |
use GData's resumable upload API, so should be more reliable than a normal upload (especially if the file is large). See the
|
|
Packit |
4b6dd7 |
GData documentation on resumable uploads for more
|
|
Packit |
4b6dd7 |
information.
|
|
Packit |
4b6dd7 |
The HTTP method to use should be specified in method
|
|
Packit |
4b6dd7 |
, and will typically be either SOUP_METHOD_POST (for insertions) or SOUP_METHOD_PUT
|
|
Packit |
4b6dd7 |
(for updates), according to the server and the upload_uri
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
If entry
|
|
Packit |
4b6dd7 |
is specified, it will be attached to the upload as the entry to which the file being uploaded belongs. Otherwise, just the file
|
|
Packit |
4b6dd7 |
written to the stream will be uploaded, and given a default entry as determined by the server.
|
|
Packit |
4b6dd7 |
slug
|
|
Packit |
4b6dd7 |
, content_type
|
|
Packit |
4b6dd7 |
and content_length
|
|
Packit |
4b6dd7 |
must be specified before the upload begins, as they describe the file being streamed. slug
|
|
Packit |
4b6dd7 |
is the filename
|
|
Packit |
4b6dd7 |
given to the file, which will typically be stored on the server and made available when downloading the file again. content_type
|
|
Packit |
4b6dd7 |
must be the
|
|
Packit |
4b6dd7 |
correct content type for the file, and should be in the service's list of acceptable content types. content_length
|
|
Packit |
4b6dd7 |
must be the size of the file
|
|
Packit |
4b6dd7 |
being uploaded (not including the XML for any associated GDataEntry) in bytes. Zero is accepted if a metadata-only upload is being performed.
|
|
Packit |
4b6dd7 |
As well as the standard GIO errors, calls to the GOutputStream API on a GDataUploadStream can also return any relevant specific error from
|
|
Packit |
4b6dd7 |
GDataServiceError, or GDATA_SERVICE_ERROR_PROTOCOL_ERROR in the general case.
|
|
Packit |
4b6dd7 |
If a GCancellable is provided in cancellable
|
|
Packit |
4b6dd7 |
, the upload operation may be cancelled at any time from another thread using g_cancellable_cancel().
|
|
Packit |
4b6dd7 |
In this case, any ongoing network activity will be stopped, and any pending or future calls to GOutputStream API on the GDataUploadStream will
|
|
Packit |
4b6dd7 |
return G_IO_ERROR_CANCELLED. Note that the GCancellable objects which can be passed to individual GOutputStream operations will not cancel the
|
|
Packit |
4b6dd7 |
upload operation proper if cancelled — they will merely cancel that API call. The only way to cancel the upload operation completely is using this
|
|
Packit |
4b6dd7 |
cancellable
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
Note that network communication won't begin until the first call to g_output_stream_write() on the GDataUploadStream.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service
|
|
Packit |
4b6dd7 |
a GDataService
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
domain
|
|
Packit |
4b6dd7 |
the GDataAuthorizationDomain to authorize the upload, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
method
|
|
Packit |
4b6dd7 |
the HTTP method to use
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
upload_uri
|
|
Packit |
4b6dd7 |
the URI to upload
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
entry
|
|
Packit |
4b6dd7 |
the entry to upload as metadata, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
slug
|
|
Packit |
4b6dd7 |
the file's slug (filename)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
content_type
|
|
Packit |
4b6dd7 |
the content type of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
content_length
|
|
Packit |
4b6dd7 |
the size (in bytes) of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
cancellable
|
|
Packit |
4b6dd7 |
a GCancellable for the entire upload stream, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GOutputStream, or NULL; unref with g_object_unref()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.13.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_response ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_response (GDataUploadStream *self,
|
|
Packit |
4b6dd7 |
gssize *length);
|
|
Packit |
4b6dd7 |
Returns the server's response to the upload operation performed by the GDataUploadStream. If the operation
|
|
Packit |
4b6dd7 |
is still underway, or the server's response hasn't been received yet, NULL is returned and length
|
|
Packit |
4b6dd7 |
is set to -1.
|
|
Packit |
4b6dd7 |
If there was an error during the upload operation (but it is complete), NULL is returned, and length
|
|
Packit |
4b6dd7 |
is set to 0.
|
|
Packit |
4b6dd7 |
While it is safe to call this function from any thread at any time during the network operation, the only way to guarantee that the response has
|
|
Packit |
4b6dd7 |
been set before calling this function is to have closed the GDataUploadStream by calling g_output_stream_close() on it, without cancelling
|
|
Packit |
4b6dd7 |
the close operation. Once the stream has been closed, all network communication is guaranteed to have finished. Note that if a call to
|
|
Packit |
4b6dd7 |
g_output_stream_close() is cancelled, g_output_stream_is_closed() will immediately start to return TRUE, even if the GDataUploadStream is still
|
|
Packit |
4b6dd7 |
attempting to flush the network buffers asynchronously — consequently, gdata_upload_stream_get_response() may still return NULL and a length
|
|
Packit |
4b6dd7 |
of
|
|
Packit |
4b6dd7 |
-1. The only reliable way to determine if the stream has been fully closed in this situation is to check the results
|
|
Packit |
4b6dd7 |
of gdata_upload_stream_get_response(), rather than g_output_stream_is_closed().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
length
|
|
Packit |
4b6dd7 |
return location for the length of the response, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none][out caller-allocates]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the server's response to the upload, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_service ()
|
|
Packit |
4b6dd7 |
GDataService *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_service (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the service used to authorize the upload, as passed to gdata_upload_stream_new().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the GDataService used to authorize the upload.
|
|
Packit |
4b6dd7 |
[transfer none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_authorization_domain ()
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_authorization_domain
|
|
Packit |
4b6dd7 |
(GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the authorization domain used to authorize the upload, as passed to gdata_upload_stream_new(). It may be NULL if authorization is not
|
|
Packit |
4b6dd7 |
needed for the upload.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the GDataAuthorizationDomain used to authorize the upload, or NULL.
|
|
Packit |
4b6dd7 |
[transfer none][allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_cancellable ()
|
|
Packit |
4b6dd7 |
GCancellable *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_cancellable (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the GCancellable for the entire upload operation, “cancellable”.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the GCancellable for the entire upload operation.
|
|
Packit |
4b6dd7 |
[transfer none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.8.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_method ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_method (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the HTTP request method being used to upload the file, as passed to gdata_upload_stream_new().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the HTTP request method in use
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_upload_uri ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_upload_uri (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the URI the file is being uploaded to, as passed to gdata_upload_stream_new().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the URI which the file is being uploaded to
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_entry ()
|
|
Packit |
4b6dd7 |
GDataEntry *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_entry (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the entry being used to upload metadata, if one was passed to gdata_upload_stream_new().
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the entry used for metadata, or NULL.
|
|
Packit |
4b6dd7 |
[transfer none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_slug ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_slug (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the slug (filename) of the file being uploaded.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the slug of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_type ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_type (GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the content type of the file being uploaded.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the content type of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_length ()
|
|
Packit |
4b6dd7 |
goffset
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_content_length
|
|
Packit |
4b6dd7 |
(GDataUploadStream *self);
|
|
Packit |
4b6dd7 |
Gets the size (in bytes) of the file being uploaded. This will be -1 for a non-resumable upload, and zero or greater
|
|
Packit |
4b6dd7 |
for a resumable upload.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataUploadStream
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the size of the file being uploaded
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.13.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_LINK_RESUMABLE_CREATE_MEDIA
|
|
Packit |
4b6dd7 |
#define GDATA_LINK_RESUMABLE_CREATE_MEDIA "http://schemas.google.com/g/2005#resumable-create-media"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The relation type URI of the resumable upload location for resources attached to this resource.
|
|
Packit |
4b6dd7 |
For more information, see the
|
|
Packit |
4b6dd7 |
GData resumable upload protocol
|
|
Packit |
4b6dd7 |
specification.
|
|
Packit |
4b6dd7 |
Since: 0.13.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_LINK_RESUMABLE_EDIT_MEDIA
|
|
Packit |
4b6dd7 |
#define GDATA_LINK_RESUMABLE_EDIT_MEDIA "http://schemas.google.com/g/2005#resumable-edit-media"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The relation type URI of the resumable update location for resources attached to this resource.
|
|
Packit |
4b6dd7 |
For more information, see the
|
|
Packit |
4b6dd7 |
GData resumable upload protocol
|
|
Packit |
4b6dd7 |
specification.
|
|
Packit |
4b6dd7 |
Since: 0.13.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataUploadStream
|
|
Packit |
4b6dd7 |
typedef struct _GDataUploadStream GDataUploadStream;
|
|
Packit |
4b6dd7 |
All the fields in the GDataUploadStream structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataUploadStreamClass
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
} GDataUploadStreamClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
All the fields in the GDataUploadStreamClass structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Property Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “authorization-domain” property
|
|
Packit |
4b6dd7 |
“authorization-domain” GDataAuthorizationDomain *
|
|
Packit |
4b6dd7 |
The authorization domain for the upload, against which the “authorizer” for the “service” should be
|
|
Packit |
4b6dd7 |
authorized. This may be NULL if authorization is not needed for the upload.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “cancellable” property
|
|
Packit |
4b6dd7 |
“cancellable” GCancellable *
|
|
Packit |
4b6dd7 |
An optional cancellable used to cancel the entire upload operation. If a GCancellable instance isn't provided for this property at
|
|
Packit |
4b6dd7 |
construction time (i.e. to gdata_upload_stream_new()), one will be created internally and can be retrieved using
|
|
Packit |
4b6dd7 |
gdata_upload_stream_get_cancellable() and used to cancel the upload operation with g_cancellable_cancel() just as if it was passed to
|
|
Packit |
4b6dd7 |
gdata_upload_stream_new().
|
|
Packit |
4b6dd7 |
If the upload operation is cancelled using this GCancellable, any ongoing network activity will be stopped, and any pending or future calls
|
|
Packit |
4b6dd7 |
to GOutputStream API on the GDataUploadStream will return G_IO_ERROR_CANCELLED. Note that the GCancellable objects which can be passed
|
|
Packit |
4b6dd7 |
to individual GOutputStream operations will not cancel the upload operation proper if cancelled — they will merely cancel that API call.
|
|
Packit |
4b6dd7 |
The only way to cancel the upload operation completely is using “cancellable”.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Since: 0.8.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “content-length” property
|
|
Packit |
4b6dd7 |
“content-length” gint64
|
|
Packit |
4b6dd7 |
The content length (in bytes) of the file being uploaded (i.e. as returned by g_file_info_get_size()). Note that this does not include the
|
|
Packit |
4b6dd7 |
length of the XML serialisation of “entry”, if set.
|
|
Packit |
4b6dd7 |
If this is -1 the upload will be non-resumable; if it is non-negative, the upload will be resumable.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Allowed values: >= -1
|
|
Packit |
4b6dd7 |
Default value: -1
|
|
Packit |
4b6dd7 |
Since: 0.13.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “content-type” property
|
|
Packit |
4b6dd7 |
“content-type” gchar *
|
|
Packit |
4b6dd7 |
The content type of the file being uploaded (i.e. as returned by g_file_info_get_content_type()).
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “entry” property
|
|
Packit |
4b6dd7 |
“entry” GDataEntry *
|
|
Packit |
4b6dd7 |
The entry used for metadata to upload.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “method” property
|
|
Packit |
4b6dd7 |
“method” gchar *
|
|
Packit |
4b6dd7 |
The HTTP request method to use when uploading the file.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “service” property
|
|
Packit |
4b6dd7 |
“service” GDataService *
|
|
Packit |
4b6dd7 |
The service which is used to authorize the upload, and to which the upload relates.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “slug” property
|
|
Packit |
4b6dd7 |
“slug” gchar *
|
|
Packit |
4b6dd7 |
The slug of the file being uploaded. This is usually the display name of the file (i.e. as returned by g_file_info_get_display_name()).
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “upload-uri” property
|
|
Packit |
4b6dd7 |
“upload-uri” gchar *
|
|
Packit |
4b6dd7 |
The URI to upload the data and metadata to. This must be HTTPS.
|
|
Packit |
4b6dd7 |
Flags: Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.5.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|