expo-sharing/src/Sharing.ts

Provides a way to share files directly with other compatible applications.

import { UnavailabilityError } from 'expo-modules-core';

import type { ResolvedSharePayload, SharePayload, SharingOptions } from './Sharing.types';
import SharingNativeModule from './SharingNativeModule';

// @needsAudit
/**
 * Determine if the sharing API can be used in this app.
 * @return A promise that fulfills with `true` if the sharing API can be used, and `false` otherwise.
 */
export async function isAvailableAsync(): Promise<boolean> {
  if (SharingNativeModule) {
    if (SharingNativeModule.isAvailableAsync) {
      return await SharingNativeModule.isAvailableAsync();
    }
    return true;
  }

  return false;
}

// @needsAudit
/**
 * Opens action sheet to share file to different applications which can handle this type of file.
 * @param url Local file URL to share.
 * @param options A map of share options.
 */
export async function shareAsync(url: string, options: SharingOptions = {}): Promise<void> {
  if (!SharingNativeModule || !SharingNativeModule.shareAsync) {
    throw new UnavailabilityError('Sharing', 'shareAsync');
  }
  return await SharingNativeModule.shareAsync(url, options);
}

/**
 * Returns raw data shared with the app. Returns an empty array if no data has been shared with the app.
 *
 * @platform android
 * @platform ios
 * @experimental
 */
export function getSharedPayloads(): SharePayload[] {
  return SharingNativeModule.getSharedPayloads();
}

/**
 * Returns resolved data shared with the app. Compared to data returned from [`getSharedPayloads`](#sharinggetsharedpayloads) contains additional
 * information useful for reading and displaying the data. For example, when a web `URL` is shared with the app,
 * a resolved payload will contain additional information about the URL contents.
 *
 * > Depending on what has been shared, this method may require a network connection to resolve content details.
 *
 * @platform android
 * @platform ios
 * @experimental
 */
export async function getResolvedSharedPayloadsAsync(): Promise<ResolvedSharePayload[]> {
  return await SharingNativeModule.getResolvedSharedPayloadsAsync();
}

/**
 * Clears the data shared with the app.
 */
export function clearSharedPayloads(): void {
  SharingNativeModule.clearSharedPayloads();
}