Files
Overview of files service
CodeMash Files service allows you to store all your project files. These files include files from the database, user files, and custom files. All the files can be seen from the dashboard in the file browser.
To start using Files services and API methods you firstly need to enable files service in your CodeMash dashboard.
Features included in files service:
  1. 1.
    File storage - storing your project files.

If you decide to use one of our provided SDK, the following code shows how to initialize files service.
.NET
Node
PHP
var projectId = Guid.Parse("{YOUR_PROJECT_ID}");
var apiKey = "{YOUR_SECRET_KEY}";
​
var client = new CodeMashClient(apiKey, projectId);
var filesService = new CodeMashFilesService(client);
​
use Codemash\CodemashClient;
use Codemash\CodemashFile;
​
class CodemashService
{
protected CodemashFile $codemashFile;
​
public function __construct()
{
$secretKey = '{YOUR_SECRET_KEY}';
$projectId = '{YOUR_PROJECT_ID}';
​
$client = new CodemashClient($secretKey, $projectId);
$this->codemashFile = new CodemashFile($client);
}
}

The following are examples of files SDK using different languages and frameworks.
.NET
Node
PHP
using System;
using CodeMash.Client;
using CodeMash.Membership.Services;
using Isidos.CodeMash.ServiceContracts;
​
namespace ConsoleApplication
{
class Program
{
static void Main(string[] args)
{
// 1. Get your Project ID and Secret Key
var projectId = Guid.Parse("{YOUR_PROJECT_ID}");
var apiKey = "{YOUR_SECRET_KEY}";
​
// 2. Create a general client for API calls
var client = new CodeMashClient(apiKey, projectId);
// 3. Create a service object
var filesService = new CodeMashFilesService(client);
​
// 4. Get path to your file
var directory = Path.GetDirectoryName(
Assembly.GetExecutingAssembly().Location
);
var filePath = quot;{directory}\\test.txt";
// 5. Get file stream
using (var fsSource = new FileStream(path, FileMode.Open,
FileAccess.Read))
{
// 6. Call an API method
var response = await filesService.UploadFileAsync(
fsSource,
"test.txt",
new UploadFileRequest
{
Path = "folder1"
}
);
}
}
}
}
​
use Codemash\CodemashClient;
use Codemash\CodemashFile;
​
class CodemashService
{
protected CodemashFile $codemashFile;
​
public function __construct()
{
$secretKey = '{YOUR_SECRET_KEY}';
$projectId = '{YOUR_PROJECT_ID}';
​
$client = new CodemashClient($secretKey, $projectId);
$this->codemashFile = new CodemashFile($client);
}
​
public function uploadFile()
{
$responseData = $codemashFile->uploadRecordFile([
'fileUri' => '{YOUR_FILE_PATH}',
'fileName' => '{YOUR_FILE_NAME}',
'collectionName' => '{COLLECTION_NAME}',
'recordId' => '{RECORD_ID}',
'uniqueFieldName' => 'file_field_name',
]);
}
}

The following links explore the usage of files service:
Last modified 2mo ago
Copy link
On this page
Using SDK
Example
Working with Files Service