Class RemoteServiceModule

Provides access to Snap authorized remote services.

Hierarchy (View Summary, Expand)

Asset
- RemoteServiceModule

Index

Constructors

Properties

name uniqueIdentifier

Methods

createWebSocket createWebView createWebViewOptions fetch getTypeName isOfType isSame makeResourceFromUrl performApiRequest performHttpRequest subscribeApiRequest

Constructors

`Protected`constructor

new RemoteServiceModule(): RemoteServiceModule
Returns RemoteServiceModule
Overrides Asset.constructor

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

createWebSocket

createWebSocket(url: string): WebSocket
Wearable Only
Deprecated. This method has been moved to InternetModule.
Parameters
- url: string
Returns WebSocket
Deprecated

createWebView

createWebView(
    options: WebViewOptions,
    onSuccess: (texture: Texture) => void,
    onFailure: (errorMessage: string) => void,
): void
Experimental Wearable Only
Deprecated. This method has been moved to InternetModule.
Parameters
- options: WebViewOptions
- onSuccess: (texture: Texture) => void
- onFailure: (errorMessage: string) => void
Returns void
Deprecated

`Static`createWebViewOptions

createWebViewOptions(resolution: vec2): WebViewOptions
Experimental Wearable Only
Deprecated. This method has been moved to InternetModule.
Parameters
- resolution: vec2
Returns WebViewOptions

fetch

fetch(request: string | Request, options?: any): Promise<Response>
Wearable Only
Deprecated. This method has been moved to InternetModule.
Parameters
- request: string | Request
- Optionaloptions: any
Returns Promise<Response>
Deprecated

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Asset.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame

makeResourceFromUrl

makeResourceFromUrl(mediaUrl: string): DynamicResource
Wearable Only Camera Kit
Get a DynamicResource to be used with RemoteMediaModule from mediaUrl.
Parameters
- mediaUrl: string
Returns DynamicResource

performApiRequest

performApiRequest(
request: RemoteApiRequest,
onApiResponse: (response: RemoteApiResponse) => void,
): void
Parameters
- request: RemoteApiRequest
- onApiResponse: (response: RemoteApiResponse) => void
Returns void

performHttpRequest

performHttpRequest(
requestOptions: RemoteServiceHttpRequest,
onHttpResponse: (response: RemoteServiceHttpResponse) => void,
): void
Wearable Only Camera Kit
Deprecated. This method has been moved to InternetModule.
Parameters
- requestOptions: RemoteServiceHttpRequest
- onHttpResponse: (response: RemoteServiceHttpResponse) => void
Returns void
Deprecated

subscribeApiRequest

subscribeApiRequest(
request: RemoteApiRequest,
onApiResponse: (response: RemoteApiResponse) => void,
): string
Parameters
- request: RemoteApiRequest
- onApiResponse: (response: RemoteApiResponse) => void
Returns string