datatransfer_interface.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2026 Savoir-faire Linux Inc.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LIBJAMI_DATATRANSFERI_H
#define LIBJAMI_DATATRANSFERI_H
 
#include "def.h"
 
#include "jami.h"
 
#include <string>
#include <map>
#include <memory>
 
namespace libjami {
 
[[deprecated("Replaced by registerSignalHandlers")]] LIBJAMI_PUBLIC void registerDataXferHandlers(
    const std::map<std::string, std::shared_ptr<CallbackWrapperBase>>&);
 
using DataTransferId = uint64_t;
 
enum class LIBJAMI_PUBLIC DataTransferEventCode : uint8_t {
    invalid = 0,
    created,
    unsupported,
    wait_peer_acceptance,
    wait_host_acceptance,
    ongoing,
    finished,
    closed_by_host,
    closed_by_peer,
    invalid_pathname,
    unjoinable_peer,
    timeout_expired,
};
 
enum class LIBJAMI_PUBLIC DataTransferError : uint8_t {
    success = 0,
    unknown,
    io,
    invalid_argument,
};
 
enum class LIBJAMI_PUBLIC DataTransferFlags : uint8_t {
    direction = 0, 
};
 
struct LIBJAMI_PUBLIC DataTransferInfo
{
    std::string accountId;                                            
    DataTransferEventCode lastEvent {DataTransferEventCode::invalid}; 
    uint32_t flags {0};                                               
    int64_t totalSize {0};     
    int64_t bytesProgress {0}; 
    std::string author;
    std::string peer; 
    std::string conversationId;
    std::string displayName; 
    std::string path;        
    std::string mimetype;    
};
 
 
LIBJAMI_PUBLIC void sendFile(const std::string& accountId,
                             const std::string& conversationId,
                             const std::string& path,
                             const std::string& displayName,
                             const std::string& replyTo) noexcept;
 
LIBJAMI_PUBLIC bool downloadFile(const std::string& accountId,
                                 const std::string& conversationId,
                                 const std::string& interactionId,
                                 const std::string& fileId,
                                 const std::string& path) noexcept;
 
DataTransferError cancelDataTransfer(const std::string& accountId,
                                     const std::string& conversationId,
                                     const std::string& fileId) noexcept LIBJAMI_PUBLIC;
 
LIBJAMI_PUBLIC DataTransferError fileTransferInfo(const std::string& accountId,
                                                  const std::string& conversationId,
                                                  const std::string& fileId,
                                                  std::string& path,
                                                  int64_t& total,
                                                  int64_t& progress) noexcept;
 
// Signals
struct LIBJAMI_PUBLIC DataTransferSignal
{
    struct LIBJAMI_PUBLIC DataTransferEvent
    {
        constexpr static const char* name = "DataTransferEvent";
        using cb_type = void(const std::string& accountId,
                             const std::string& conversationId,
                             const std::string& interactionId,
                             const std::string& fileId,
                             int eventCode);
    };
};
 
} // namespace libjami
 
#endif // LIBJAMI_DATATRANSFERI_H