Class RemoteApiRequest

body

endpoint

""
Copy

parameters

uriResources

[]
Copy

Staticcreate

• create(): RemoteApiRequest

  Returns RemoteApiRequest

  Since

  Lens Scripting Version 164

StaticgetTypeName

• getTypeName(): string

  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 string

  Since

  Lens Scripting Version 164

setSnapchatUserIdParameter

• setSnapchatUserIdParameter(key: string, user: SafeSnapchatUser): void

  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

  • key: string
  • user: SafeSnapchatUser

  Returns void

  Since

  Lens Scripting Version 372

  Camera Kit

  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);
  Copy