// Copyright Epic Games, Inc. All Rights Reserved.
// This file is automatically generated. Changes to this file may be overwritten.
namespace Epic.OnlineServices.TitleStorage
{
public sealed partial class TitleStorageInterface : Handle
{
public TitleStorageInterface()
{
}
public TitleStorageInterface(System.IntPtr innerHandle) : base(innerHandle)
{
}
///
/// The most recent version of the API.
///
public const int CopyfilemetadataatindexoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int CopyfilemetadatabyfilenameoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int DeletecacheoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int FilemetadataApiLatest = 2;
///
/// Maximum File Name Length in bytes
///
public const int FilenameMaxLengthBytes = 64;
///
/// The most recent version of the API.
///
public const int GetfilemetadatacountoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int QueryfilelistoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int QueryfileoptionsApiLatest = 1;
///
/// The most recent version of the API.
///
public const int ReadfileoptionsApiLatest = 1;
///
/// Get the cached copy of a file's metadata by index. The metadata will be for the last retrieved version. The returned pointer must be released by the user when no longer needed.
///
///
///
/// Object containing properties related to which user is requesting metadata, and at what index
/// A copy of the FileMetadata structure will be set if successful. This data must be released by calling .
///
/// if the requested metadata is currently cached, otherwise an error result explaining what went wrong.
///
public Result CopyFileMetadataAtIndex(CopyFileMetadataAtIndexOptions options, out FileMetadata outMetadata)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var outMetadataAddress = System.IntPtr.Zero;
var funcResult = Bindings.EOS_TitleStorage_CopyFileMetadataAtIndex(InnerHandle, optionsAddress, ref outMetadataAddress);
Helper.TryMarshalDispose(ref optionsAddress);
if (Helper.TryMarshalGet(outMetadataAddress, out outMetadata))
{
Bindings.EOS_TitleStorage_FileMetadata_Release(outMetadataAddress);
}
return funcResult;
}
///
/// Create a cached copy of a file's metadata by filename. The metadata will be for the last retrieved or successfully saved version, and will not include any changes that have not
/// completed writing. The returned pointer must be released by the user when no longer needed.
///
/// Object containing properties related to which user is requesting metadata, and for which filename
/// A copy of the FileMetadata structure will be set if successful. This data must be released by calling .
///
/// if the metadata is currently cached, otherwise an error result explaining what went wrong
///
public Result CopyFileMetadataByFilename(CopyFileMetadataByFilenameOptions options, out FileMetadata outMetadata)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var outMetadataAddress = System.IntPtr.Zero;
var funcResult = Bindings.EOS_TitleStorage_CopyFileMetadataByFilename(InnerHandle, optionsAddress, ref outMetadataAddress);
Helper.TryMarshalDispose(ref optionsAddress);
if (Helper.TryMarshalGet(outMetadataAddress, out outMetadata))
{
Bindings.EOS_TitleStorage_FileMetadata_Release(outMetadataAddress);
}
return funcResult;
}
///
/// Clear previously cached file data. This operation will be done asynchronously. All cached files except those corresponding to the transfers in progress will be removed.
/// Warning: Use this with care. Cache system generally tries to clear old and unused cached files from time to time. Unnecessarily clearing cache can degrade performance as SDK will have to re-download data.
///
/// Object containing properties related to which user is deleting cache
/// Optional pointer to help clients track this request, that is returned in associated callbacks
/// This function is called when the delete cache operation completes
///
/// if the operation was started correctly, otherwise an error result explaining what went wrong
///
public Result DeleteCache(DeleteCacheOptions options, object clientData, OnDeleteCacheCompleteCallback completionCallback)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var clientDataAddress = System.IntPtr.Zero;
var completionCallbackInternal = new OnDeleteCacheCompleteCallbackInternal(OnDeleteCacheCompleteCallbackInternalImplementation);
Helper.AddCallback(ref clientDataAddress, clientData, completionCallback, completionCallbackInternal);
var funcResult = Bindings.EOS_TitleStorage_DeleteCache(InnerHandle, optionsAddress, clientDataAddress, completionCallbackInternal);
Helper.TryMarshalDispose(ref optionsAddress);
return funcResult;
}
///
/// Get the count of files we have previously queried information for and files we have previously read from / written to.
///
///
/// Object containing properties related to which user is requesting the metadata count
///
/// If successful, the count of metadata currently cached. Returns 0 on failure.
///
public uint GetFileMetadataCount(GetFileMetadataCountOptions options)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var funcResult = Bindings.EOS_TitleStorage_GetFileMetadataCount(InnerHandle, optionsAddress);
Helper.TryMarshalDispose(ref optionsAddress);
return funcResult;
}
///
/// Query a specific file's metadata, such as file names, size, and a MD5 hash of the data. This is not required before a file may be opened. Once a file has
/// been queried, its metadata will be available by the and functions.
///
///
///
///
/// Object containing properties related to which user is querying files, and what file is being queried
/// Optional pointer to help clients track this request, that is returned in the completion callback
/// This function is called when the query operation completes
public void QueryFile(QueryFileOptions options, object clientData, OnQueryFileCompleteCallback completionCallback)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var clientDataAddress = System.IntPtr.Zero;
var completionCallbackInternal = new OnQueryFileCompleteCallbackInternal(OnQueryFileCompleteCallbackInternalImplementation);
Helper.AddCallback(ref clientDataAddress, clientData, completionCallback, completionCallbackInternal);
Bindings.EOS_TitleStorage_QueryFile(InnerHandle, optionsAddress, clientDataAddress, completionCallbackInternal);
Helper.TryMarshalDispose(ref optionsAddress);
}
///
/// Query the file metadata, such as file names, size, and a MD5 hash of the data, for all files available for current user based on their settings (such as game role) and tags provided.
/// This is not required before a file can be downloaded by name.
///
/// Object containing properties related to which user is querying files and the list of tags
/// Optional pointer to help clients track this request, that is returned in the completion callback
/// This function is called when the query operation completes
public void QueryFileList(QueryFileListOptions options, object clientData, OnQueryFileListCompleteCallback completionCallback)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var clientDataAddress = System.IntPtr.Zero;
var completionCallbackInternal = new OnQueryFileListCompleteCallbackInternal(OnQueryFileListCompleteCallbackInternalImplementation);
Helper.AddCallback(ref clientDataAddress, clientData, completionCallback, completionCallbackInternal);
Bindings.EOS_TitleStorage_QueryFileList(InnerHandle, optionsAddress, clientDataAddress, completionCallbackInternal);
Helper.TryMarshalDispose(ref optionsAddress);
}
///
/// Retrieve the contents of a specific file, potentially downloading the contents if we do not have a local copy, from the cloud. This request will occur asynchronously, potentially over
/// multiple frames. All callbacks for this function will come from the same thread that the SDK is ticked from. If specified, the FileTransferProgressCallback will always be called at
/// least once if the request is started successfully.
///
///
/// Object containing properties related to which user is opening the file, what the file's name is, and related mechanisms for copying the data
/// Optional pointer to help clients track this request, that is returned in associated callbacks
/// This function is called when the read operation completes
///
/// A valid Title Storage File Request handle if successful, or NULL otherwise. Data contained in the completion callback will have more detailed information about issues with the request in failure cases. This handle must be released when it is no longer needed
///
public TitleStorageFileTransferRequest ReadFile(ReadFileOptions options, object clientData, OnReadFileCompleteCallback completionCallback)
{
var optionsAddress = System.IntPtr.Zero;
Helper.TryMarshalSet(ref optionsAddress, options);
var clientDataAddress = System.IntPtr.Zero;
var completionCallbackInternal = new OnReadFileCompleteCallbackInternal(OnReadFileCompleteCallbackInternalImplementation);
Helper.AddCallback(ref clientDataAddress, clientData, completionCallback, completionCallbackInternal, options.ReadFileDataCallback, ReadFileOptionsInternal.ReadFileDataCallback, options.FileTransferProgressCallback, ReadFileOptionsInternal.FileTransferProgressCallback);
var funcResult = Bindings.EOS_TitleStorage_ReadFile(InnerHandle, optionsAddress, clientDataAddress, completionCallbackInternal);
Helper.TryMarshalDispose(ref optionsAddress);
TitleStorageFileTransferRequest funcResultReturn;
Helper.TryMarshalGet(funcResult, out funcResultReturn);
return funcResultReturn;
}
[MonoPInvokeCallback(typeof(OnDeleteCacheCompleteCallbackInternal))]
internal static void OnDeleteCacheCompleteCallbackInternalImplementation(System.IntPtr data)
{
OnDeleteCacheCompleteCallback callback;
DeleteCacheCallbackInfo callbackInfo;
if (Helper.TryGetAndRemoveCallback(data, out callback, out callbackInfo))
{
callback(callbackInfo);
}
}
[MonoPInvokeCallback(typeof(OnFileTransferProgressCallbackInternal))]
internal static void OnFileTransferProgressCallbackInternalImplementation(System.IntPtr data)
{
OnFileTransferProgressCallback callback;
FileTransferProgressCallbackInfo callbackInfo;
if (Helper.TryGetStructCallback(data, out callback, out callbackInfo))
{
FileTransferProgressCallbackInfo dataObj;
Helper.TryMarshalGet(data, out dataObj);
callback(dataObj);
}
}
[MonoPInvokeCallback(typeof(OnQueryFileCompleteCallbackInternal))]
internal static void OnQueryFileCompleteCallbackInternalImplementation(System.IntPtr data)
{
OnQueryFileCompleteCallback callback;
QueryFileCallbackInfo callbackInfo;
if (Helper.TryGetAndRemoveCallback(data, out callback, out callbackInfo))
{
callback(callbackInfo);
}
}
[MonoPInvokeCallback(typeof(OnQueryFileListCompleteCallbackInternal))]
internal static void OnQueryFileListCompleteCallbackInternalImplementation(System.IntPtr data)
{
OnQueryFileListCompleteCallback callback;
QueryFileListCallbackInfo callbackInfo;
if (Helper.TryGetAndRemoveCallback(data, out callback, out callbackInfo))
{
callback(callbackInfo);
}
}
[MonoPInvokeCallback(typeof(OnReadFileCompleteCallbackInternal))]
internal static void OnReadFileCompleteCallbackInternalImplementation(System.IntPtr data)
{
OnReadFileCompleteCallback callback;
ReadFileCallbackInfo callbackInfo;
if (Helper.TryGetAndRemoveCallback(data, out callback, out callbackInfo))
{
callback(callbackInfo);
}
}
[MonoPInvokeCallback(typeof(OnReadFileDataCallbackInternal))]
internal static ReadResult OnReadFileDataCallbackInternalImplementation(System.IntPtr data)
{
OnReadFileDataCallback callback;
ReadFileDataCallbackInfo callbackInfo;
if (Helper.TryGetStructCallback(data, out callback, out callbackInfo))
{
ReadFileDataCallbackInfo dataObj;
Helper.TryMarshalGet(data, out dataObj);
var funcResult = callback(dataObj);
return funcResult;
}
return Helper.GetDefault();
}
}
}