Titanium.Network.BonjourBrowser

A browser for the discovery and retrieval of Bonjour services available on the network.

Use the Titanium.Network.createBonjourBrowser method to create a BonjourBrowser instance.

If your application publishes Bonjour services itself, that service will be discovered by the browser if necessary; be prepared to perform a check if you do not want to list local services as available. Bonjour service browsing is an asynchronous operation, meaning that you should be extremely careful when caching values from the services property returned by the updatedservices event. In particular, if you maintain a local copy of available services and a user tries to connect to one, you should be prepared to handle failures gracefully; the next updatedservices event should provide the new services list, but you should not rely on it being delivered before user input. When a window which uses Bonjour browsing is closed, if you do not want to continue searching, you must call the stop() method.

In iOS 14.0+, to browse services add key NSLocalNetworkUsageDescription and NSBonjourServices to the ios plist section of the tiapp.xml file.

Example:

<ti:app>
  <!-- ... -->
  <ios>
    <plist>
      <dict>
        <!-- Reason to access local network-->
        <key>NSLocalNetworkUsageDescription</key>
        <string>
            Specify the reason for accessing the local network.
            This appears in the alert dialog when asking the user 
            for permission to access local network.
        </string>
        <!-- List of bonjour service type-->
        <key>NSBonjourServices</key>
        <array>
          <string>_test._tcp</string>
        <array/>
      </dict>
    </plist>
  </ios>
  <!-- ... -->
</ti:app>

Extends: Titanium.Proxy · Since: 1.2.0 · Platforms: iphone, ipad, macos

Properties

apiName

extended

3.2.0

3.2.0

3.2.0

9.2.0

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

bubbleParent

extended

3.0.0

3.0.0

3.0.0

9.2.0

Type: Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

domain

0.9

0.9

0.9

9.2.0

Type: String

The domain the browser is searching in

isSearching

0.9

0.9

0.9

9.2.0

Type: Boolean

Whether or not the browser is currently searching

lifecycleContainer

extended

3.6.0

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

serviceType

0.9

0.9

0.9

9.2.0

Type: String

The type of the service the browser searches for

Methods

addEventListener

extended

0.9

0.9

0.9

9.2.0

Adds the specified callback as an event listener for the named event.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired.	No

applyProperties

extended

3.0.0

3.0.0

3.0.0

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.

Parameters:

Name	Type	Summary	Optional
props	Dictionary	A dictionary of properties to apply.	No

fireEvent

extended

0.9

0.9

0.9

9.2.0

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
event	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

removeEventListener

extended

0.9

0.9

0.9

9.2.0

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function
in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to addEventListener.	No

search

0.9

0.9

0.9

9.2.0

Conduct a search for Bonjour services matching the type and domain specified during creation

stopSearch

0.9

0.9

0.9

9.2.0

Halt an ongoing search

Events

updatedservices

3.0.0

3.0.0

3.0.0

3.0.0

Fired when the discovered services list is updated

Event Properties:

Name	Type	Summary
services	Array<Titanium.Network.BonjourService>	An array of BonjourService objects corresponding to currently available services. If you cache this value, including using it as table data, be aware that it could become out of date at any time due to the asynchronous nature of Bonjour service discovery.