The Be-Bound Developer Hub

Welcome to the Be-Bound developer hub. You'll find comprehensive guides and documentation to help you start working with Be-Bound as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting started

A Be-Bound Manifest is an XML file describing the content of the API between the App and the Server. Your Be-Bound Manifest describes the different Messages you can exchange using Be-Bound Technology. Each Messages is composed of zero or more Parameters. Each Parameter has its own Type, which defines the allowed data in it.

General Overview

A Be-Bound Manifest contains the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<beapp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns="https://be-bound.com/v7/Manifest"
       xsi:schemaLocation="https://be-bound.com/v7/Manifest">
  <enumerations>
    (...)
  </enumerations>
  
  <messages>
    (...)
  </messages>

</beapp>

Enumerations

The Enumeration is a special type formed by a list of custom values. These values are attached in your Messages; being a highly optimized way to transmit a bounded amount of data.

You can get more information about enumeration here.

Messages

The Messages represents the structured data interchangeable thought Be-Bound Technology. Each Message works indistinctly between the Apps to their Server and between the Server to their Apps.

  • You can get more information about Messages here.
  • You can get more information about managing your Be-Bound Manifest here.

Examples

Be-Bound Template

<?xml version="1.0" encoding="UTF-8"?>
<beapp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="https://be-bound.com/v7/Manifest"
    xsi:schemaLocation="https://be-bound.com/v7/Manifest">

    <messages>
        <message name="send_text_request">
            <string name="content" />
        </message>
        <message name="send_text_response">
            <integer
                name="speedtest_seq"
                min="1"
                max="16"/>
        </message>
    </messages>

</beapp>

Complete example

<?xml version="1.0" encoding="UTF-8"?>
<beapp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="https://be-bound.com/v7/Manifest"
    xsi:schemaLocation="https://be-bound.com/v7/Manifest">

    <enumerations>
        <enum name="enum_type">
            <value>NORTH</value>
            <value>SOUTH</value>
            <value>EAST</value>
            <value>WEST</value>
        </enum>
    </enumerations>

    <messages>
        <message name="concat_test">
           <integer name="concat_integer"/>
           <boolean name="concat_bool"/>
           <string name="concat_string"/>
           <timestamp name="concat_timestamp"/>
           <gpsLocation name="concat_gps_location"/>
           <float name="concat_float"/>
           <double name="concat_double"/>
           <long name="concat_long"/>
           <short name="concat_short"/>
           <collection name="concat_collection" message="collection_link_test"/>
           <binaryStream name="concat_binary_stream"/>
           <array name="concat_array">
               <integer name="array_int"/>
           </array>
           <byte name="concat_byte"/>
           <enumeration name="concat_enumeration" ref="enum_type"/>
       </message>
    </messages>
</beapp>

Updated about a year ago

Getting started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.