Skip to main content

Auto attach files

Automatically attach a log file to each ticket, or user's profile photo, or whatever will help you resolve the ticket faster when you receive it. Files you attach automatically are not visible to your users.

Auto-attached files vs. Files uploaded by users

When submitting a ticket from the New ticket screen, your users can also upload their files (images, documents) to tickets. That has nothing to do with these auto-attached files.

Methods

You can programmatically attach files by using any of the methods described below. To define which files will be uploaded, call the Shake.setShakeReportData method and pass the list of ShakeFile objects, as shown in the examples below.

note

You can call the Shake.setShakeReportData method anywhere in your app, just be careful to only call it once since any subsequent calls will override the former ones.

Set a custom filename and then attach a file

ShakeFile can be initialized with a desired filename (String) and an absolute file path (String) to your file:

main.dart
import 'package:shake_flutter/shake_flutter.dart';
import 'package:shake_flutter/models/shake_file.dart';
void attachLogFiles() {
var shakeFile1 = ShakeFile.create(userFile.path, 'userLogs');
var shakeFile2 = ShakeFile.create(deviceFile.path, 'deviceLogs');
Shake.setShakeReportData([shakeFile1, shakeFile2]);
}

Attach a file without the custom filename

ShakeFile can be initialized without a filename, with just an absolute file path (String) to your file. If you initialize it this way, the filename shown on your Shake dashboard will be determined automatically from the passed file's name.

main.dart
import 'package:shake_flutter/shake_flutter.dart';
import 'package:shake_flutter/models/shake_file.dart';
void attachLogFiles(String username) {
var shakeFile1 = ShakeFile.create(userFile.path);
var shakeFile2 = ShakeFile.create(deviceFile.path);
Shake.setShakeReportData([shakeFile1, shakeFile2]);
}

Limitations

The maximum number of auto attached files per ticket is 1 for Free workspaces and 10 for Premium workspaces. If more files are attached, Shake SDK will successfully upload only some of them.

The maximum allowed individual size for any of those auto attached files is 10 MB. If you programmatically attach a file that's larger than that, it won't be uploaded with the ticket.