Options
All
  • Public
  • Public/Protected
  • All
Menu

@snapchat/snap-kit-react-native - v0.2.0

Index

Type aliases

ImageData

ImageData: { raw: string } | { uri: string }

Type that represents the two supported image formats: raw (base64) and URI.

CreativeKitType

CreativeKitType: { sharePhoto: any; shareVideo: any; shareToCameraPreview: any; shareLensToCameraPreview: any }

Type declaration

  • sharePhoto: function
    • Shares a still image content to Snapchat preview.

        CreativeKit.sharePhoto({
         content: {
           // add photo data
         },
         sticker: {
           // optional sticker data
         },
         attachmentUrl: "",
         caption: ""
        });
      

      Parameters

      Returns Promise<void>

  • shareVideo: function
    • Shares a video content to Snapchat preview.

        CreativeKit.shareVideo({
         content: {
           // add video data
         },
         sticker: {
           // optional sticker data
         },
         attachmentUrl: "",
         caption: ""
        });
      

      Parameters

      Returns Promise<void>

  • shareToCameraPreview: function
    • Opens SnapChat camera with optional metadata.

        CreativeKit.shareToCameraPreview({
         sticker: {
           // optional sticker data
         },
         attachmentUrl: "",
         caption: ""
        });
      

      Parameters

      Returns Promise<void>

  • shareLensToCameraPreview: function
    • shareLensToCameraPreview(lensContent: LensContentParams): Promise<void>
    • Shares a lens attachment to Snapchat camera.

        CreativeKit.shareLensToCameraPreview({
         lensUUID: "",
         launchData: {
           // additional key-value attributes for the lens
         }
         attachmentUrl: "",
         caption: ""
        });
      

      Parameters

      • lensContent: LensContentParams

      Returns Promise<void>

Variables

Const CreativeKit

CreativeKit: CreativeKitType = ...

Generated using TypeDoc