Class Push2Web

constructor

• new Push2Web(): Push2Web

• Create new instance of Push2Web object, it can be used to start listening for the events, subscribe or unsubscribe for notifications from Lens Studio. Also provides the extension object for the @snap/camera-kit package.

  Returns Push2Web

Readonlyevents

push2web.events.addEventListener('error', ({ detail }) => {
  if (detail.name === 'LensExcludedError') {
    console.log(`Lens is excluded from the push, by the following reason: ${detail.reason}.`)
  }
})
Copy

extension

• get extension(): ExtensionContainer

• The extension object must be passed to the Camera Kit object during its bootstrap process. This is a requirement for the proper functioning of push to web functionality.

  Returns ExtensionContainer

  Example

  import { bootstrapCameraKit } from "@snap/camera-kit";
  
  const push2web = new Push2Web();
  const extensions = (container) => container.provides(push2Web.extension);
  
  const cameraKit = await bootstrapCameraKit({ apiToken: "token from developer portal" }, extensions);
  const cameraKitSession = await cameraKit.createSession();
  Copy

subscribe

• subscribe(
      accessToken: string,
      cameraKitSession: CameraKitSession,
      repository: LensRepository,
  ): SubscriptionInstance

• Initiate subscription for the events from Lens Studio.

  Parameters

  • accessToken: string

    After user will be logged in to the web page, using Snapchat account, you can get access token from Login Kit.
  • cameraKitSession: CameraKitSession

    Instance of CameraKitSession object form @snap/camera-kit package.
  • repository: LensRepository

    Instance of LensRepository object from @snap/camera-kit package.

  Returns SubscriptionInstance

  Subscription Instance