Skip to content
  • Documentation >
  • Apps >
  • File and Document Management >
  • Shufflrr

Shufflrr

The Shufflrr modules allow you to create, update, list, retrieve, and delete, the files, folders, and folder contents in your Shufflrr account.

Getting Started with Shufflrr

Prerequisites

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Shufflrr to Ibexa Connect

To connect your Shufflrr account to Ibexa Connect you need to obtain the email address, password, and domain from your Shufflrr account and insert them in the Create a connection dialog in the Ibexa Connect module.

  1. Log in to your Ibexa Connect account, add a module from the Shufflrr app into an Ibexa Connect scenario.

  2. Click Add next to the Connection field.

    Shufflrr.gif

  3. In the Connection name field, enter a name for the connection.

  4. In the Email Address and Password fields, enter your Shufflrr account credentials.

  5. In the Domain field, enter your Shufflrr account domain name. For example, if your Shufflrr account URL address is https://xyz.shufflrr.com then your domain is xyz.

  6. Click Continue.

    The connection is established.

Presentations

List Files

Lists all files.
Limit Set the maximum number of files Ibexa Connect should return during one execution cycle. The default value is 10.

Get a File

Retrieves the specified file.
File ID Select or map the File ID whose details you want to retrieve.

Update a File

Updates the specified file.
File ID Select or map the File ID whose details you want to update.
Name Enter (map) a new name for the File.
Description Enter (map) the detailed description of the file.

Delete a File

Deletes the specified file.
File ID Select or map the File ID you want to delete.
Expiry Date Enter (map) the date on which the file expires or gets deleted. See the list of supported time and date formats.
Clear Expiry Date Select whether to remove the expiry date for the file.

Upload a file

Uploads a file to the specified folder.

Folder ID

Select or map the Folder ID from where you want to upload a file.

Source File

Enter (map) the additional details for the uploaded file

File Name

Enter (map) the file name including the extension. For example, invoice.xml.

File Data

Enter (map) the file data.

Folders

List Root Folders

Returns the root folder for the current user.
Limit Set the maximum number of root folders Ibexa Connect should return during one execution cycle. The default value is 10.

Get a Folders Tree

Returns a tree of all folders the user has access to.
Writeable Only Select whether the folders are writeable only.

List Folder Contents

Returns the contents of the specified folder.
Folder ID Select or map the Folder ID whose contents you want to list.
Limit Set the maximum number of contents Ibexa Connect should return during one execution cycle. The default value is 10.

Get a Folder

Returns the specified folder.
Folder ID Select or map the Folder ID whose details you want to retrieve.

Create a Folder

Adds a folder to the portal.

Name

Enter (map) a new name for the Folder.

File Type

Select the type of the file:

  • Presentation

  • Image

  • Video

  • Document

  • Other File

  • Folder

Is Folder

Select whether the created file is a folder.

Is Followed by Current User

Select whether you want to follow the folder to watch its contents.

User Permissions

Select the user permissions for the folder:

  • None

  • Read

  • Write

  • Share

  • Read Full

  • Full Control

Description

Enter (map) the folder details.

Parent Folder ID

Select or map the Parent Folder ID if this folder is part of any other folder.

Update a Folder

Updates the specified folder.
Folder ID Select or map the Folder ID you want to update.
Name Enter (map) a new name for the Folder.

Delete a Folder

Removes the specified folder.

Folder ID

Select or map the Folder ID you want to delete.

File ID

Select or map the File IDs of the folder you want to delete.

Slide Update Mode

Select the update mode of the slide:

  • Don't Delete

  • Automatic

  • Manual

Note: This field specifies whether to delete slides on presentations within the folder.

Clear Expiry Date

Select whether to remove the expiry date for the folder.

Expiry Date

Enter (map) the date on which you want to delete the folder.

Move a File into a Folder

Moves the file(s) to the specified folder.
File ID Select or map the File ID you want to move to a specified folder.
Target Folder ID Select or map the Folder ID to which you want to move the above-selected file.
Overwrite Existing Select whether you want to overwrite the existing file.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://<domain>.shufflrr.com/. For example: api/folders.

For the list of available endpoints, refer to the Shufflrr API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Files

The following API call returns all the files from your Shufflrr account:

URL:

api/files

Method:

GET

61f279afddfef.png

Matches of the search can be found in the module's Output under Bundle > Body.

In our example, 5 files were returned:

61f279b11db7e.png

Download a File

Downloads a file specified by ID.
File ID Select or map the File ID you want to download.