File Transfer channels

File Transfer channels — service-side interface for the File Transfer channel type

Functions

Signals

void file-transfer-state-changed Has Details
void initial-offset-defined Has Details
void transferred-bytes-changed Has Details
void u-ri-defined Has Details

Types and Values

Object Hierarchy

    GInterface
    ╰── TpSvcChannelTypeFileTransfer

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

This section documents the auto-generated GInterface used to implement the File Transfer channel type.

Functions

tp_svc_channel_type_file_transfer_accept_file_impl ()

void
(*tp_svc_channel_type_file_transfer_accept_file_impl)
                               (TpSvcChannelTypeFileTransfer *self,
                                guint in_Address_Type,
                                guint in_Access_Control,
                                const GValue *in_Access_Control_Param,
                                guint64 in_Offset,
                                DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method AcceptFile on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

self

The object implementing this interface

 

in_Address_Type

guint (FIXME, generate documentation)

 

in_Access_Control

guint (FIXME, generate documentation)

 

in_Access_Control_Param

const GValue * (FIXME, generate documentation)

 

in_Offset

guint64 (FIXME, generate documentation)

 

context

Used to return values or throw an error

 

tp_svc_channel_type_file_transfer_emit_file_transfer_state_changed ()

void
tp_svc_channel_type_file_transfer_emit_file_transfer_state_changed
                               (gpointer instance,
                                guint arg_State,
                                guint arg_Reason);

Type-safe wrapper around g_signal_emit to emit the FileTransferStateChanged signal on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

instance

The object implementing this interface

 

arg_State

guint (FIXME, generate documentation)

 

arg_Reason

guint (FIXME, generate documentation)

 

tp_svc_channel_type_file_transfer_emit_initial_offset_defined ()

void
tp_svc_channel_type_file_transfer_emit_initial_offset_defined
                               (gpointer instance,
                                guint64 arg_InitialOffset);

Type-safe wrapper around g_signal_emit to emit the InitialOffsetDefined signal on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

instance

The object implementing this interface

 

arg_InitialOffset

guint64 (FIXME, generate documentation)

 

tp_svc_channel_type_file_transfer_emit_transferred_bytes_changed ()

void
tp_svc_channel_type_file_transfer_emit_transferred_bytes_changed
                               (gpointer instance,
                                guint64 arg_Count);

Type-safe wrapper around g_signal_emit to emit the TransferredBytesChanged signal on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

instance

The object implementing this interface

 

arg_Count

guint64 (FIXME, generate documentation)

 

tp_svc_channel_type_file_transfer_emit_uri_defined ()

void
tp_svc_channel_type_file_transfer_emit_uri_defined
                               (gpointer instance,
                                const gchar *arg_URI);

Type-safe wrapper around g_signal_emit to emit the URIDefined signal on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

instance

The object implementing this interface

 

arg_URI

const gchar * (FIXME, generate documentation)

 

tp_svc_channel_type_file_transfer_implement_accept_file ()

void
tp_svc_channel_type_file_transfer_implement_accept_file
                               (TpSvcChannelTypeFileTransferClass *klass,
                                tp_svc_channel_type_file_transfer_accept_file_impl impl);

Register an implementation for the AcceptFile method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the AcceptFile D-Bus method

 

tp_svc_channel_type_file_transfer_implement_provide_file ()

void
tp_svc_channel_type_file_transfer_implement_provide_file
                               (TpSvcChannelTypeFileTransferClass *klass,
                                tp_svc_channel_type_file_transfer_provide_file_impl impl);

Register an implementation for the ProvideFile method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

 

impl

A callback used to implement the ProvideFile D-Bus method

 

tp_svc_channel_type_file_transfer_provide_file_impl ()

void
(*tp_svc_channel_type_file_transfer_provide_file_impl)
                               (TpSvcChannelTypeFileTransfer *self,
                                guint in_Address_Type,
                                guint in_Access_Control,
                                const GValue *in_Access_Control_Param,
                                DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method ProvideFile on interface org.freedesktop.Telepathy.Channel.Type.FileTransfer.

Parameters

self

The object implementing this interface

 

in_Address_Type

guint (FIXME, generate documentation)

 

in_Access_Control

guint (FIXME, generate documentation)

 

in_Access_Control_Param

const GValue * (FIXME, generate documentation)

 

context

Used to return values or throw an error

 

tp_svc_channel_type_file_transfer_return_from_accept_file ()

void
tp_svc_channel_type_file_transfer_return_from_accept_file
                               (DBusGMethodInvocation *context,
                                const GValue *out_Address);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

Parameters

context

The D-Bus method invocation context

 

out_Address

const GValue * (FIXME, generate documentation)

 

tp_svc_channel_type_file_transfer_return_from_provide_file ()

void
tp_svc_channel_type_file_transfer_return_from_provide_file
                               (DBusGMethodInvocation *context,
                                const GValue *out_Address);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

Parameters

context

The D-Bus method invocation context

 

out_Address

const GValue * (FIXME, generate documentation)

 

Types and Values

TpSvcChannelTypeFileTransfer

typedef struct _TpSvcChannelTypeFileTransfer TpSvcChannelTypeFileTransfer;

Dummy typedef representing any implementation of this interface.


TpSvcChannelTypeFileTransferClass

typedef struct _TpSvcChannelTypeFileTransferClass TpSvcChannelTypeFileTransferClass;

The class of TpSvcChannelTypeFileTransfer.

In a full implementation of this interface (i.e. all methods implemented), the interface initialization function used in G_IMPLEMENT_INTERFACE() would typically look like this:

static void
implement_channel_type_file_transfer (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_type_file_transfer_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (accept_file);
  IMPLEMENT (provide_file);
#undef IMPLEMENT
}

Signal Details

The “file-transfer-state-changed” signal

void
user_function (TpSvcChannelTypeFileTransfer *self,
               guint                         arg_State,
               guint                         arg_Reason,
               gpointer                      user_data)

The FileTransferStateChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

 

arg_State

guint (FIXME, generate documentation)

 

arg_Reason

guint (FIXME, generate documentation)

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details


The “initial-offset-defined” signal

void
user_function (TpSvcChannelTypeFileTransfer *self,
               guint64                       arg_InitialOffset,
               gpointer                      user_data)

The InitialOffsetDefined D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

 

arg_InitialOffset

guint64 (FIXME, generate documentation)

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details


The “transferred-bytes-changed” signal

void
user_function (TpSvcChannelTypeFileTransfer *self,
               guint64                       arg_Count,
               gpointer                      user_data)

The TransferredBytesChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

 

arg_Count

guint64 (FIXME, generate documentation)

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details


The “u-ri-defined” signal

void
user_function (TpSvcChannelTypeFileTransfer *self,
               gchar                        *arg_URI,
               gpointer                      user_data)

The URIDefined D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

 

arg_URI

const gchar * (FIXME, generate documentation)

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details