Logical Labs Multipeer Module

API Docs for: 1.0.0
Show:

AdvertiserAssistant Class

Module: Readme

This is a convenience class that handles advertising, presents incoming invitations to the user and handles users’ responses. This class should be used to provide a user interface for handling invitations when your app does not require programmatic control over the invitation process.

Methods

start

() Void

Available since 1.0.0

Begins advertising the service provided by a local peer.

Returns:

Void:

stop

() Void

Available since 1.0.0

Stops advertising the service provided by a local peer.

Returns:

Void:

Properties

discoveryInfo

Object read-only

Available since 1.0.0

The discoveryInfo passed when this Advertiser Assistant was created.

serviceType

String read-only

Available since 1.0.0

The service type that your app is advertising.

session

Session read-only

Available since 1.0.0

The Session object used to create this Advertiser Assistant.

Events

dismissedInvitation

Available since 1.0.0

Indicates that the advertiser assistant finished showing the invitation to the user.

willPresentInvitation

Available since 1.0.0

Indicates that the advertiser assistant is about to present an invitation to the user.