Player Files

Detailed Description

Server-side management of CDN-backed files scoped to a player's profile.

Read, upload, update, and delete player files from the server. Ideal for cloud saves, screenshots, or profile pictures that benefit from CDN delivery. Each file upload requires a declared purpose; files can be marked private to restrict client visibility. Up to five revisions per file are retained.

See the LootLocker documentation.

Function Documentation

DeleteFileByKeyForPlayer()

static FString ULootLockerServerForCpp::DeleteFileByKeyForPlayer ( int  PlayerID, const FString &  Key, const FLootLockerServerPlayerFileDeleteResponseDelegate &  OnCompletedRequest  )

static

Delete a player file by its key.

Parameters

PlayerID	ID of the player
Key	The key of the file to delete
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

DeleteFileForPlayerByID()

static FString ULootLockerServerForCpp::DeleteFileForPlayerByID ( int  PlayerID, int  FileID, const FLootLockerServerPlayerFileDeleteResponseDelegate &  OnCompletedRequest  )

static

Delete the specified file currently associated with the specified player The response will be empty unless there's an error.

Parameters

PlayerID	ID of the player for whom to delete the specified file
FileID	ID of the file to delete
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetFileByKeyForPlayer()

static FString ULootLockerServerForCpp::GetFileByKeyForPlayer ( int  PlayerID, const FString &  Key, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Get a player file by its key (upsert key)

Parameters

PlayerID	ID of the player
Key	The key of the file
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetFileForPlayerByID()

static FString ULootLockerServerForCpp::GetFileForPlayerByID ( int  PlayerID, int  FileID, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Get the specified file currently associated with the specified player.

Parameters

PlayerID	ID of the player for whom to get the specified file
FileID	ID of the file to get
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetFileRevisionByKeyForPlayer()

static FString ULootLockerServerForCpp::GetFileRevisionByKeyForPlayer ( int  PlayerID, const FString &  Key, const FString &  RevisionID, const FLootLockerServerPlayerFileContentResponseDelegate &  OnCompletedRequest  )

static

Get a specific revision of a player file by its key and revision ULID.

Parameters

PlayerID	ID of the player
Key	The key of the file
RevisionID	The ULID of the revision to retrieve
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetFileRevisionForPlayerByID()

static FString ULootLockerServerForCpp::GetFileRevisionForPlayerByID ( int  PlayerID, int  FileID, const FString &  RevisionID, const FLootLockerServerPlayerFileContentResponseDelegate &  OnCompletedRequest  )

static

Get a specific revision of a player file by its revision ULID.

Parameters

PlayerID	ID of the player
FileID	ID of the file
RevisionID	The ULID of the revision to retrieve
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListFileRevisionsByKeyForPlayer()

static FString ULootLockerServerForCpp::ListFileRevisionsByKeyForPlayer ( int  PlayerID, const FString &  Key, const FLootLockerServerPlayerFileRevisionsListResponseDelegate &  OnCompletedRequest  )

static

List all revisions for a player file identified by its key.

Parameters

PlayerID	ID of the player
Key	The key of the file
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListFileRevisionsForPlayer()

static FString ULootLockerServerForCpp::ListFileRevisionsForPlayer ( int  PlayerID, int  FileID, const FLootLockerServerPlayerFileRevisionsListResponseDelegate &  OnCompletedRequest  )

static

List all revisions for a player file.

Parameters

PlayerID	ID of the player
FileID	ID of the file
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListFilesForPlayer()

static FString ULootLockerServerForCpp::ListFilesForPlayer ( int  PlayerID, const FLootLockerServerPlayerFileListResponseDelegate &  OnCompletedRequest  )

static

List files currently associated with the specified player.

Parameters

PlayerID	ID of the player for whom to list files
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

PromoteFileRevisionByKeyForPlayer()

static FString ULootLockerServerForCpp::PromoteFileRevisionByKeyForPlayer ( int  PlayerID, const FString &  Key, const FString &  RevisionID, const FLootLockerServerPlayerFilePromoteResponseDelegate &  OnCompletedRequest  )

static

Promote a specific revision to be the current (active) revision of a player file identified by its key.

Parameters

PlayerID	ID of the player
Key	The key of the file
RevisionID	The ULID of the revision to promote
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

PromoteFileRevisionForPlayer()

static FString ULootLockerServerForCpp::PromoteFileRevisionForPlayer ( int  PlayerID, int  FileID, const FString &  RevisionID, const FLootLockerServerPlayerFilePromoteResponseDelegate &  OnCompletedRequest  )

static

Promote a specific revision to be the current (active) revision of a player file.

Parameters

PlayerID	ID of the player
FileID	ID of the file
RevisionID	The ULID of the revision to promote
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UpdateFileForPlayer()

static FString ULootLockerServerForCpp::UpdateFileForPlayer ( int  PlayerID, int  FileID, FString  FilePath, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Update the specified file for the specified player with the supplied file content.

Parameters

PlayerID	ID of the player for whom to update the specified file
FileID	ID of the file to update
FilePath	The path on disk to the file you want to update the specified file with
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UpdatePlayerFileWithRawData()

static FString ULootLockerServerForCpp::UpdatePlayerFileWithRawData ( int  PlayerID, int  FileID, TArray< uint8 >  RawData, const FString &  FileName, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Update the specified file for the specified player with the supplied raw data.

Parameters

PlayerID	ID of the player for whom to update the specified file
FileID	ID of the file to update
RawData	The raw data to update the specified file with
FileName	The name to set for the file
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UploadFileForPlayer()

static FString ULootLockerServerForCpp::UploadFileForPlayer ( int  PlayerID, FString  FilePath, FString  Purpose, bool  IsPublic, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Upload the specified file to the specified player Each file can be a maximum of 5MB and each player can have a maximum of 50 files.

Parameters

PlayerID	ID of the player for whom to upload the specified file
FilePath	The path on disk to the file you want to upload
Purpose	A tag specifying the purpose of this file
IsPublic	Whether this file is publically available (accessible for other players)
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UploadFileForPlayerByKey()

static FString ULootLockerServerForCpp::UploadFileForPlayerByKey ( int  PlayerID, FString  FilePath, FString  Purpose, bool  IsPublic, FString  Key, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Upload the specified file to the specified player, using a key for upsert behavior Each file can be a maximum of 5MB and each player can have a maximum of 50 files.

Parameters

PlayerID	ID of the player for whom to upload the specified file
FilePath	The path on disk to the file you want to upload
Purpose	A tag specifying the purpose of this file
IsPublic	Whether this file is publically available (accessible for other players)
Key	The key for upsert behavior. If a file with this key already exists, it will be updated.
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UploadRawDataToPlayerFile()

static FString ULootLockerServerForCpp::UploadRawDataToPlayerFile ( int  PlayerID, TArray< uint8 >  RawData, const FString &  FileName, FString  Purpose, bool  IsPublic, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Upload the supplied raw data as a file to the specified player Each file can be a maximum of 5MB and each player can have a maximum of 50 files.

Parameters

PlayerID	ID of the player for whom to upload the specified file
RawData	The raw data to upload to a player file
FileName	The name to set for the file
Purpose	A tag specifying the purpose of this file
IsPublic	Whether this file is publically available (accessible for other players)
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

UploadRawDataToPlayerFileByKey()

static FString ULootLockerServerForCpp::UploadRawDataToPlayerFileByKey ( int  PlayerID, TArray< uint8 >  RawData, const FString &  FileName, FString  Purpose, bool  IsPublic, FString  Key, const FLootLockerServerSinglePlayerFileResponseDelegate &  OnCompletedRequest  )

static

Upload the supplied raw data as a file to the specified player, using a key for upsert behavior Each file can be a maximum of 5MB and each player can have a maximum of 50 files.

Parameters

PlayerID	ID of the player for whom to upload the specified file
RawData	The raw data to upload to a player file
FileName	The name to set for the file
Purpose	A tag specifying the purpose of this file
IsPublic	Whether this file is publically available (accessible for other players)
Key	The key for upsert behavior. If a file with this key already exists, it will be updated.
OnCompletedRequest	Delegate for handling the server response

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

Functions
static FString	ULootLockerServerForCpp::ListFilesForPlayer (int PlayerID, const FLootLockerServerPlayerFileListResponseDelegate &OnCompletedRequest)
	List files currently associated with the specified player.
static FString	ULootLockerServerForCpp::GetFileForPlayerByID (int PlayerID, int FileID, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Get the specified file currently associated with the specified player.
static FString	ULootLockerServerForCpp::DeleteFileForPlayerByID (int PlayerID, int FileID, const FLootLockerServerPlayerFileDeleteResponseDelegate &OnCompletedRequest)
	Delete the specified file currently associated with the specified player The response will be empty unless there's an error.
static FString	ULootLockerServerForCpp::UploadFileForPlayer (int PlayerID, FString FilePath, FString Purpose, bool IsPublic, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Upload the specified file to the specified player Each file can be a maximum of 5MB and each player can have a maximum of 50 files.
static FString	ULootLockerServerForCpp::UploadFileForPlayerByKey (int PlayerID, FString FilePath, FString Purpose, bool IsPublic, FString Key, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Upload the specified file to the specified player, using a key for upsert behavior Each file can be a maximum of 5MB and each player can have a maximum of 50 files.
static FString	ULootLockerServerForCpp::UploadRawDataToPlayerFile (int PlayerID, TArray< uint8 > RawData, const FString &FileName, FString Purpose, bool IsPublic, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Upload the supplied raw data as a file to the specified player Each file can be a maximum of 5MB and each player can have a maximum of 50 files.
static FString	ULootLockerServerForCpp::UploadRawDataToPlayerFileByKey (int PlayerID, TArray< uint8 > RawData, const FString &FileName, FString Purpose, bool IsPublic, FString Key, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Upload the supplied raw data as a file to the specified player, using a key for upsert behavior Each file can be a maximum of 5MB and each player can have a maximum of 50 files.
static FString	ULootLockerServerForCpp::UpdateFileForPlayer (int PlayerID, int FileID, FString FilePath, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Update the specified file for the specified player with the supplied file content.
static FString	ULootLockerServerForCpp::UpdatePlayerFileWithRawData (int PlayerID, int FileID, TArray< uint8 > RawData, const FString &FileName, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Update the specified file for the specified player with the supplied raw data.
static FString	ULootLockerServerForCpp::ListFileRevisionsForPlayer (int PlayerID, int FileID, const FLootLockerServerPlayerFileRevisionsListResponseDelegate &OnCompletedRequest)
	List all revisions for a player file.
static FString	ULootLockerServerForCpp::GetFileRevisionForPlayerByID (int PlayerID, int FileID, const FString &RevisionID, const FLootLockerServerPlayerFileContentResponseDelegate &OnCompletedRequest)
	Get a specific revision of a player file by its revision ULID.
static FString	ULootLockerServerForCpp::PromoteFileRevisionForPlayer (int PlayerID, int FileID, const FString &RevisionID, const FLootLockerServerPlayerFilePromoteResponseDelegate &OnCompletedRequest)
	Promote a specific revision to be the current (active) revision of a player file.
static FString	ULootLockerServerForCpp::GetFileByKeyForPlayer (int PlayerID, const FString &Key, const FLootLockerServerSinglePlayerFileResponseDelegate &OnCompletedRequest)
	Get a player file by its key (upsert key)
static FString	ULootLockerServerForCpp::ListFileRevisionsByKeyForPlayer (int PlayerID, const FString &Key, const FLootLockerServerPlayerFileRevisionsListResponseDelegate &OnCompletedRequest)
	List all revisions for a player file identified by its key.
static FString	ULootLockerServerForCpp::GetFileRevisionByKeyForPlayer (int PlayerID, const FString &Key, const FString &RevisionID, const FLootLockerServerPlayerFileContentResponseDelegate &OnCompletedRequest)
	Get a specific revision of a player file by its key and revision ULID.
static FString	ULootLockerServerForCpp::PromoteFileRevisionByKeyForPlayer (int PlayerID, const FString &Key, const FString &RevisionID, const FLootLockerServerPlayerFilePromoteResponseDelegate &OnCompletedRequest)
	Promote a specific revision to be the current (active) revision of a player file identified by its key.
static FString	ULootLockerServerForCpp::DeleteFileByKeyForPlayer (int PlayerID, const FString &Key, const FLootLockerServerPlayerFileDeleteResponseDelegate &OnCompletedRequest)
	Delete a player file by its key.