IOnlineSharedCloud

Provides the interface for sharing files already on the cloud with other users

Choose your operating system:

Windows

macOS

Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineSharedCloudInterface.h

Include

#include "Interfaces/OnlineSharedCloudInterface.h"

Syntax

class IOnlineSharedCloud

Remarks

Provides the interface for sharing files already on the cloud with other users

Variables

Name Description

Public variable

FOnReadSharedFi...

 

OnReadSharedFileCompleteDelegates

Delegate fired when a shared file read from the network platform's storage is complete

Public variable

FOnWriteSharedF...

 

OnWriteSharedFileCompleteDelegates

Delegate fired when a shared file write to the network platform's storage is complete

Constructors

Name Description

Protected function

IOnlineSharedCloud()

Destructors

Name Description

Public function Virtual

~IOnlineSharedCloud()

Functions

Name Description

Public function Virtual

FDelegateHan...

 

AddOnReadSharedFileCompleteDelegate_Handle

(
    const FOnReadSharedFileCompleteDele...
)

Public function Virtual

FDelegateHan...

 

AddOnWriteSharedFileCompleteDelegate_Handle

(
    const FOnWriteSharedFileCompleteDel...
)

Public function Virtual

void

 

ClearOnReadSharedFileCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnReadSharedFileCompleteDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnWriteSharedFileCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnWriteSharedFileCompleteDelegates

(
    void* Object
)

Public function

bool

 

ClearSharedFile

(
    const FSharedContentHandle& Shared...
)

Empties the cached data for this file if it is not being downloaded currently

Public function

bool

 

ClearSharedFiles()

Empties the set of all downloaded files if possible (no async tasks outstanding)

Public function

void

 

GetDummySharedHandlesForTest

Interface to get some test content handles

Public function

bool

 

GetSharedFileContents

(
    const FSharedContentHandle& Shared...,
    TArray< uint8 >& FileContents
)

Copies the shared data into the specified buffer for the specified file

Public function

bool

 

ReadSharedFile

(
    const FSharedContentHandle& Shared...
)

Starts an asynchronous read of the specified shared file from the network platform's file store

Public function Virtual

void

 

TriggerOnReadSharedFileCompleteDelegates

(
    bool Param1,
    const FSharedContentHandle& Param2
)

Public function Virtual

void

 

TriggerOnWriteSharedFileCompleteDelegates

(
    bool Param1,
    const FUniqueNetId& Param2,
    const FString& Param3,
    const TSharedRef< FSharedContentHan...
)

Public function

bool

 

WriteSharedFile

(
    const FUniqueNetId& UserId,
    const FString& Filename,
    TArray< uint8 >& Contents
)

Starts an asynchronous write of the specified shared file to the network platform's file store