Saving Items to the Local File System

    Description

    IntuiFace enables users to save one or more images, videos, audio files and documents or snapshots of annotated images and spaces to the local file system.

    NOTE: Networked drives can also be used. Although not physically local, these drives can be treated as if they were installed locally.

    Preparing an Experience to Save to the Local File System

    To enable the saving of items to the local file system, add the Share via File System interface asset to your experience:

    Then select this interface asset in the Interface Asset panel and, in the Properties panel at the bottom of Composer, configure it as needed. See below for detailed information.

    Saving Items to the Local File System

    To save items to the local file system, you must add them to the sharing queue. Every item in the sharing queue will be saved to the local filesystem. In fact, if there are multiple items in the sharing queue, it is not possible to selectively save only a subset of those items.

    There are two ways to add Image, Video, Audio and Document assets into the sharing queue:

    1. Enable the Show sharing button property in the Tools section of the More Properties panel for the asset you may want to email.



      By touching this button in a running experience, the asset is added to the sharing queue.



      NOTE: Annotated images and scenes are added to the sharing queue by using the Snapshot button in the Drawing Tool. After annotating your images, click the snapshot button (see image below). A copy - the snapshot - is created. Press the Sharing button on this copy.



    2. Call the "Add in sharing queue" action of the Asset. You can call this action using any IntuiFace trigger. A parameter of this action is specification of which sharing queue to use.



      NOTE: Use the "Remove from sharing queue" trigger to remove this particular asset from a specified sharing queue.

    Once the items you wish to save are in the sharing queue, call the Share action of the Share via File System interface asset.

    Share-FS-Send.jpg

    More About Sharing Queues

    Each sharing interface asset - email, file system, USB drive - has its own sharing queue. However, the above methods add assets and asset snapshots to all sharing queues at the same time. To add an asset to a specific sharing queue, call that asset's Add in sharing queue action and specify which queue you are targeting.


    Sharing-AddToQueue.jpg

    If you would like to see the sharing queue as items are added/removed and even automate the Share action, add the Share via File System data template we've built for you by double-clicking the interface asset in the Interface Asset panel.

    ShareFS-Panel.jpg

    This data template illustrates what is possible with the Share via File System interface asset; you are not required to use its design or even to use it at all. The image on the right of the template simply illustrates placement of the sharing button.

    ShareFS-DA.jpg

    Properties, Triggers & Actions

    Properties

    • Destination folder: name of folder in which items shared to the file system will be saved
    • Create destination folder: toggle whether or not the Destination folder should be created if it doesn't already exist on the file system
    • Overwrite existing files: toggle whether or overwrite preexisting files with the same name as newly saved items
    • Drive storage unit: determine which measurement you want IntuiFace to use to represent capacity and free space of a given file system. These values are available via binding as properties of the Share via File System interface asset.

    Triggers

    Share via Filesystem

    • Copying already in progress: Raised when a new share is attempted while IntuiFace is already in the process of copying assets.
      • Message: The error message
    • Problem with Destination Folder: Raised when IntuiFace has difficulty accessing or using the Destination Folder.
      • Message: The error message
    • Sharing cancelled: Raised when sharing cancelled.
    • Sharing completed: Raised when sharing completed.
    • Sharing failed: Raised when an attempt to share is unable to complete.
      • Message: The error message

    Sharing queue

    • Sharing queue cleared: Raised when sharing queue selection is cleared.
    • Sharing queue item added: Raised when an item has been added to the sharing queue.
    • Sharing queue item removed: Raised when an item has been added to the sharing queue.

    ShareFileSystem-Triggers.jpg

    Actions

    Share via Filesystem

    • Share: Copy all items in sharing queue to the destination folder.
    • Cancel sharing: Cancel ongoing share attempt.

    Sharing queue

    • Add item to sharing queue: Add the item referenced by the following URI to the sharing queue.
      • URI: the local path the item to add to the sharing queue.
    • Clear sharing queue: Clear the sharing queue of all items.
    • Remove item from sharing queue: Remove the item referenced by the following URI from the sharing queue.
      • URI: the local path the item to add to the sharing queue.

    Sharingqueue.jpg