com.snapchat.kit.sdk.creative.models

Class SnapLensContent

java.lang.Object

com.snapchat.kit.sdk.creative.models.SnapContent

com.snapchat.kit.sdk.creative.models.SnapLensContent

public final class SnapLensContent
extends SnapContent

The model class for sharing a lens attachment to the Snapchat camera.

Constructor Summary

Constructors

Constructor and Description
SnapLensContent(java.lang.String lensId) Deprecated. Lens Id should no longer be used to specify lenses. Please use Lens UUID.
SnapLensContent(java.lang.String lensId, SnapLensLaunchData snapLensLaunchData) Deprecated. Lens Id should no longer be used to specify lenses. Please use createSnapLensContent to construct SnapLensContent with Lens UUID.

Method Summary

Modifier and Type	Method and Description
static SnapLensContent	createSnapLensContent(java.lang.String lensUUID, SnapLensLaunchData snapLensLaunchData) Method for constructing SnapLensContent for a lens specified by UUID.
java.lang.String	getDeeplinkUrlPath()
java.lang.String	getIntentType()
java.lang.String	getLensId() Getter for the lens id.
java.lang.String	getLensUUID() Getter for the lens id.
java.io.File	getMediaFile()
SnapLensLaunchData	getSnapLensLaunchData() Getter for the launch data.
java.lang.String	getSnapLensLaunchDataString() Getter for the string json launch data.
void	setLensId(java.lang.String lensId) Deprecated. Lens Id should no longer be used to specify lenses. Please use Lens UUID.
void	setLensUUID(java.lang.String lensUUID) Setter for the lens id.
void	setSnapLensLaunchData(SnapLensLaunchData snapLensLaunchData) Setter for the launch data.
void	setSnapSticker(SnapSticker snapSticker) Setter for the sticker.

Methods inherited from class com.snapchat.kit.sdk.creative.models.SnapContent

getAttachmentUrl, getCaptionText, getSnapSticker, setAttachmentUrl, setCaptionText

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnapLensContent

@Deprecated
public SnapLensContent(@NonNull
                                   java.lang.String lensId,
                                   @Nullable
                                   SnapLensLaunchData snapLensLaunchData)

Deprecated. Lens Id should no longer be used to specify lenses. Please use createSnapLensContent to construct SnapLensContent with Lens UUID.

Constructor for sharing a lens to snapchat with integer based ID.

Parameters:

lensId - The lens attachment id.

snapLensLaunchData - the SnapLensLaunchData object for lens launch data

SnapLensContent

@Deprecated
public SnapLensContent(@NonNull
                                   java.lang.String lensId)

Deprecated. Lens Id should no longer be used to specify lenses. Please use Lens UUID.

Constructor for sharing a lens to snapchat.

Parameters:

lensId - The lens attachment id - a string representing an integer eg ("1234567")

Method Detail

createSnapLensContent

public static SnapLensContent createSnapLensContent(@NonNull
                                                    java.lang.String lensUUID,
                                                    @Nullable
                                                    SnapLensLaunchData snapLensLaunchData)

Method for constructing SnapLensContent for a lens specified by UUID.

Parameters:

lensUUID - The lens attachment id - a string representing a dash-less UUID, eg ("123e4567e89b12d3a456426614174000")

setLensId

@Deprecated
public void setLensId(@NonNull
                                  java.lang.String lensId)

Deprecated. Lens Id should no longer be used to specify lenses. Please use Lens UUID.

Setter for the lens id.

Parameters:

lensId - The lens attachment id - a string representing an integer eg ("1234567")

setLensUUID

public void setLensUUID(@NonNull
                        java.lang.String lensUUID)

Setter for the lens id.

Parameters:

lensUUID - The lens attachment uuid - a string representing a dash-less UUID, eg ("123e4567e89b12d3a456426614174000")

setSnapLensLaunchData

public void setSnapLensLaunchData(@Nullable
                                  SnapLensLaunchData snapLensLaunchData)

Setter for the launch data.

Parameters:

snapLensLaunchData - The lens launch data.

getSnapLensLaunchData

@Nullable
public SnapLensLaunchData getSnapLensLaunchData()

Getter for the launch data.

Returns:

tThe lens launch data.

getLensUUID

public java.lang.String getLensUUID()

Getter for the lens id.

Returns:

The string lens id.

getLensId

public java.lang.String getLensId()

Getter for the lens id.

Returns:

The string lens id.

getSnapLensLaunchDataString

@Nullable
public java.lang.String getSnapLensLaunchDataString()

Getter for the string json launch data.

Returns:

The string json lens launch data.

setSnapSticker

public void setSnapSticker(SnapSticker snapSticker)

Setter for the sticker. Will always set to null since Creative Kit lenses doesn't support sticker attachments.

Overrides:

setSnapSticker in class SnapContent

Parameters:

snapSticker - The sticker.

getDeeplinkUrlPath

public java.lang.String getDeeplinkUrlPath()

Specified by:

getDeeplinkUrlPath in class SnapContent

getIntentType

public java.lang.String getIntentType()

Specified by:

getIntentType in class SnapContent

getMediaFile

@Nullable
public java.io.File getMediaFile()

Specified by:

getMediaFile in class SnapContent