Class SpectaclesMobileKitSession

Spectacles Mobile Kit session allows you to initiate the connection to peer, and send data.

Snap OS

Hierarchy (View Summary)

ScriptObject
- SpectaclesMobileKitSession

Index

Properties

isConnected onConnected onDisconnected

Methods

close getTypeName isOfType isSame sendData sendRequest start startSubscription stopSubscription

Properties

`Readonly`isConnected

isConnected: boolean

True if we’re connected to the peer.

Snap OS

`Readonly`onConnected

onConnected: event0<void>

Notified when the connection to the peer is established and ready.

Snap OS

`Readonly`onDisconnected

onDisconnected: event0<void>

Triggered when the connection to the peer is severed. The session is no longer valid and must be re-created.

Snap OS

Methods

close

close(): void
Disconnect and stop the session. Session object will be invalid after this call and will need to be re-created.

Returns void
Snap OS

getTypeName

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

Returns string
Inherited from ScriptObject.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 ScriptObject.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 ScriptObject.isSame

sendData

sendData(data: string): void
Use sendData() to send a one-way message to the connected mobile app. This is a fire-and-forget operation, no response is expected.
Parameters
- data: string
Returns void
Snap OS

sendRequest

sendRequest(data: string): Promise<string>
Send a request expecting a response from the peer. Returns a promise with the response.
Parameters
- data: string
Returns Promise<string>
Snap OS

start

start(): void
Initialize the session before interacting with the app. Ensure that all callbacks and events are configured prior to calling this method. This action creates the session and begins listening for incoming connections.

Returns void
Snap OS

startSubscription

startSubscription(
data: string,
onError: (error: string) => void,
): event1<string, void>
Start a subscription, multiple responses can be sent by the peer. Returns the subscription event. onError will be called if the subscription is cancelled by peer.
Parameters
- data: string
- onError: (error: string) => void
Returns event1<string, void>
Snap OS

stopSubscription

stopSubscription(id: event1<string, void>): void
Stop the subscription.
Parameters
- id: event1<string, void>
Returns void
Snap OS