Class

PurpleFileTransfer

since: 3.0

Description [src]

final class Purple.FileTransfer : GObject.Object {
  /* No available fields */
}

A peer to peer file transfer object.

Available since: 3.0

Ancestors

Constructors

purple_file_transfer_new_receive

Creates a new PurpleFileTransfer which will be used to negotiate a file transfer from remote to account with the given filename and file_size.

since: 3.0

purple_file_transfer_new_send

Creates a new PurpleFileTransfer which will be used to send local_file to remote.

since: 3.0

Instance methods

purple_file_transfer_get_account

Gets the PurpleAccount that transfer was created with to transfer a file.

since: 3.0

purple_file_transfer_get_cancellable

The GCancellable for transfer that can be used to cancel the transfer.

since: 3.0

purple_file_transfer_get_content_type

Gets the content type of the file being transferred.

since: 3.0

purple_file_transfer_get_error

Gets the GError from transfer.

since: 3.0

purple_file_transfer_get_file_size

Gets the size of the file that is being transferred.

since: 3.0

purple_file_transfer_get_filename

Gets the base filename from transfer.

since: 3.0

purple_file_transfer_get_initiator

Gets the PurpleContactInfo of the user that initiated transfer.

since: 3.0

purple_file_transfer_get_local_file

Gets the local file from transfer.

since: 3.0

purple_file_transfer_get_message

The message that was sent with the file transfer if the protocol supports sending one.

since: 3.0

purple_file_transfer_get_remote

Gets the PurpleContactInfo that transfer was created with to transfer a file with.

since: 3.0

purple_file_transfer_get_state

Gets the PurpleFileTransferState of the transfer.

since: 3.0

purple_file_transfer_set_content_type

Sets the content type of transfer to content_type.

since: 3.0

purple_file_transfer_set_error

Sets the error of transfer to error.

since: 3.0

purple_file_transfer_set_local_file

Sets the local file of transfer to local_file.

since: 3.0

purple_file_transfer_set_message

Sets the message to send with transfer to message.

since: 3.0

purple_file_transfer_set_state

Sets the state of transfer to state.

since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.FileTransfer:account

The account that this file transfer is for.

since: 3.0

Purple.FileTransfer:cancellable

The GCancellable for this transfer. It may be used to cancel the file transfer at any time.

since: 3.0

Purple.FileTransfer:content-type

The content or media type of the file that’s being transferred. This is meant to be used as a hint to user interfaces so they can provide previews or appropriate actions for the files.

since: 3.0

Purple.FileTransfer:error

A GError representing the failure of the transfer. This should only be set if PurpleFileTransfer:state is set to error.

since: 3.0

Purple.FileTransfer:file-size

The size of the file in bytes. A value of 0 typically means the size is unknown, but it is possible to transfer empty files as well.

since: 3.0

Purple.FileTransfer:filename

The base filename for the transfer. This is used as the default filename for the receiving side.

since: 3.0

Purple.FileTransfer:initiator

The PurpleContactInfo that initiated this file transfer.

since: 3.0

Purple.FileTransfer:local-file

The local file that is being sent or received.

since: 3.0

Purple.FileTransfer:message

Some protocols support sending a message with the file transfer. This field is to hold that message.

since: 3.0

Purple.FileTransfer:remote

The PurpleContactInfo for the remote user of this file transfer.

since: 3.0

Purple.FileTransfer:state

The state of the transfer.

since: 3.0

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PurpleFileTransferClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.