Capacitor File Sharing plugin

Original plugin and code: found here.

Installation

For Capacitor v5

npm i @hellostake/instagram
npx cap sync

For further details on what has changed see the CHANGELOG.

Versions

| Plugin | For Capacitor | Docs | Notes | | ------ | ------------- | --------------------- | ------------------------------- | | 1.x | 5.x.x | README | Breaking changes see Changelog. |

Maintainers

| Maintainer | GitHub | Social | | ------------------------- | ----------------------------------------------------------- | ------ | | Michael Oberwasserlechner | moberwasserlechner | |

Actively maintained: YES

Configuration

Starting with version 3.0.0, the plugin is registered automatically on all platforms.

Use it

import { FileSharer } from "@hellostake/instagram";

@Component({
    template: '<button (click)="downloadButtonClick()">Download file</button>',
})
export class SignupComponent {
    downloadButtonClick() {
        FileSharer.share({
            filename: "test.pdf",
            contentType: "application/pdf",
            // If you want to save base64:
            base64Data: "...",
            // If you want to save a file from a path:
            path: "../../file.pdf",
        })
            .then(() => {
                // do sth
            })
            .catch((error) => {
                console.error("File sharing failed", error.message);
            });
    }
}

Error Codes

• ERR_PARAM_NO_FILENAME ... Filename missing or invalid.
• ERR_PARAM_NO_DATA ... Base64 data missing.
• ERR_PARAM_NO_CONTENT_TYPE ... Content type missing
• ERR_PARAM_DATA_INVALID ... Base64 data is invalid. See this comment for a possible error.
• ERR_FILE_CACHING_FAILED ... Caching the file in temp directory on the device failed.

Platform: Web/PWA

Register plugin

On Web/PWA the plugin is registered automatically by Capacitor.

Platform: Android

Prerequisite: Capacitor Android Docs

Configure

Add outState.clear() to your MainActivity. This fixes android.os.TransactionTooLargeException when sharing larger files.

package com.company.project;

import android.os.Bundle;
import com.getcapacitor.BridgeActivity;

public class MainActivity extends BridgeActivity {

  @Override
  public void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);
    outState.clear();
  }
}

Register plugin

On Android the plugin is registered automatically by Capacitor.

Platform: iOS

Prerequisite: Capacitor iOS Docs

Register plugin

On iOS the plugin is registered automatically by Capacitor.

Platform: Electron

• No timeline.

Contribute

See Contribution Guidelines.

Changelog

See CHANGELOG.

License

MIT. Please see LICENSE.

Disclaimer

We have no business relation to Ionic.