Skip to main content

RemoteApiRequest

Class

Class in the Lens Scripting API.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v164

Index

Extends

Properties

body

body: string | Uint8Array<ArrayBufferLike> | number[]

Since

Lens Scripting Version 164


endpoint

endpoint: string

Since

Lens Scripting Version 164

Default Value

""

parameters

parameters: any

Since

Lens Scripting Version 164


uriResources

uriResources: DynamicResource[]

A list of DynamicResource objects to be used as URI resources in the request.

Since

Lens Scripting Version 353

Default Value

[]

Methods

create()

static create(): RemoteApiRequest

Returns

RemoteApiRequest

Since

Lens Scripting Version 164


getTypeName()

static getTypeName(): TypeName<RemoteApiRequest>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<RemoteApiRequest>

Since

Lens Scripting Version 164

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame


setSnapchatUserIdParameter()

setSnapchatUserIdParameter(key, user): void

Camera Kit

Adds the given SnapchatUser's user id to the request under the given parameter name (e.g. "friend_id"). The id is sent with the request but is not exposed back through RemoteApiRequest#parameters.

Parameters

ParameterType
keystring
userSafeUser

Returns

void

Since

Lens Scripting Version 372

Example

// friend is a SnapchatUser, e.g. from global.userContextSystem.getAllFriends
let request = RemoteApiRequest.create();
request.endpoint = 'process_remote_lens_with_friend_selection';
request.setSnapchatUserIdParameter('friend_id', friend);