Interface Lens

interface Lens {
    id: string;
    groupId: string;
    name: string;
    iconUrl: undefined | string;
    vendorData: { [key: string]: string };
    cameraFacingPreference: Lens_CameraFacing;
    preview: undefined | Preview;
    lensCreator: undefined | LensCreator;
    snapcode: undefined | Snapcode;
    featureMetadata: Any[];
}

Properties

id: string

Non-empty identifier of a unique lens available to be applied in current session.

NOTE: This value may contain unsafe characters and therefore may require additional processing depending on usages.

groupId: string

The unique identifier for the group that this lens is a part of, correlating to a collection of lenses grouped for organizational or functional purposes.

name: string

Human readable name of this lens.

NOTE: This value may contain unsafe characters and therefore may require additional processing depending on usages.

iconUrl: undefined | string

Icon resource URI that represents this lens if available.

vendorData: { [key: string]: string }

Vendor specific metadata associated with this lens, empty by default.

NOTE: Metadata values may contain unsafe characters and therefore may require additional processing depending on usages.

cameraFacingPreference: Lens_CameraFacing

Specifies a Lens_CameraFacing that this lens is designed for.

preview: undefined | Preview

Preview representing this lens, if available.

lensCreator: undefined | LensCreator

Information about the lens creator.

snapcode: undefined | Snapcode

A snapcode that represents the lens if available.

The snapcode points to the lens in the Snapchat app, when used on mobile, or a dedicated web page.

featureMetadata: Any[]

Metadata pertaining to a specific set of lens features

MMNEPVFCICPMFPCPTTAAATR