Merge branch 'develop'

sdk/client/att-api-client.js

@@ -239,7 +239,7 @@ var AttApiClient = (function () {
             _serverPath = serverPath || "";
         },
         /**
-         * Send and receive SMS messages from your application.
+         * Send and receive SMS messages from your app.
          *
          * @class AttApiClient.SMS
          * @singleton
@@ -333,7 +333,7 @@ var AttApiClient = (function () {
                 }
             },
             /**
-             * Gets a list of SMSs sent to the application's short code
+             * Gets a list of SMSs sent to the app's short code
              *
              * @param {Object} data An object which may contain the following properties:
              *   @param {Number} data.shortcode ShortCode/RegistrationId to receive messages from.
@@ -378,7 +378,7 @@ var AttApiClient = (function () {
             }
         },
         /**
-         * Send and receive MMS messages from your application
+         * Send and receive MMS messages from your app
          *
          * @class AttApiClient.MMS
          * @singleton
@@ -864,7 +864,7 @@ var AttApiClient = (function () {
             }
         },
         /**
-         * Authorize your application to access AT&T Web services
+         * Authorize your app to access AT&T Web services
          * on behalf of a user.
          *
          * @class AttApiClient.OAuth
@@ -1762,7 +1762,7 @@ var AttApiClient = (function () {
             },
 
             /**
-             * Logout of the IAM session
+             * Logout of the In-App Messaging session
              * 
              */
             logout: function logout(success, fail) {

sdk/doc_src/README.txt

@@ -1,16 +1,16 @@
-This zip file contains the documentation for AT&T's HTML5 SDK which provides an HTML5 framework for calling the AT&T API Platform.
+This ZIP file contains the documentation for the AT&T API Platform SDK for HTML5. This SDK provides an HTML5 framework for accessing the AT&T API Platform.
 ----------------------------------------------------------------
 Current Version:
 4.2
 ----------------------------------------------------------------
 Release Notes:
-This HTML5 SDK release contains the following:
+This HTML5 SDK release includes the following changes:
 
-Remove Payment and Notary APIs
-Add OAuth Revoke token support
+Removes Payment and Notary APIs
+Adds OAuth Revoke Token support
 
 ----------------------------------------------------------------
 Link to Github:
 https://github.com/attdevsupport/att-html5-sdk
 ----------------------------------------------------------------
-For information regarding the usage of this SDK please refer to docs/guides in the zip  file.
+For information regarding the usage of this SDK, please refer to docs/guides in this ZIP file.

sdk/doc_src/guides.json

@@ -9,7 +9,7 @@
             }, {
                 "name": "sdk_server_api",
                 "title": "SDK Server Protocol",
-                "description": "Overview of the Protocol between client and server"
+                "description": "Overview of the protocol between the client and the SDK server"
             }
         ]
     },
@@ -59,7 +59,7 @@
             {
                 "name": "sample_app",
                 "title": "Sample Apps",
-                "description": "Sample Apps Overview"
+                "description": "Sample Apps overview"
             },
             {
                 "name": "sample_app_test",
@@ -74,23 +74,23 @@
         {
             "name"          : "techtip_dc",
             "title"         : "Device Capabilities",
-            "description"   : "Device Capabilities Cookbook."
+            "description"   : "Device Capabilities Cookbook"
         }, {
             "name"          : "techtip_mms",
             "title"         : "MMS",
-            "description"   : "MMS messages Cookbook."
+            "description"   : "MMS Messages Cookbook"
         }, {
             "name"          : "techtip_mobo",
             "title"         : "In-App Messaging",
-            "description"   : "In-App Messages Cookbook"
+            "description"   : "In-App Messaging Cookbook"
         }, {
             "name"          : "techtip_sms",
             "title"         : "SMS",
-            "description"   : "SMS messages Cookbook."
+            "description"   : "SMS Messages Cookbook"
         }, {
             "name"          : "techtip_ads",
             "title"         : "Advertising",
-            "description"   : "Advertising Cookbook."
+            "description"   : "Advertising Cookbook"
         }, {
             "name"          : "techtip_speech",
             "title"         : "Speech",

sdk/doc_src/guides/sample_app_test/README.md

@@ -1,6 +1,6 @@
 #Using the Sample Apps
 
-Now that you have completed setting up the server component of the SDK, you should be able to load the **Sample Apps** in your supported web browser.
+Now that you have set up the server component of the SDK, you should be able to load the **Sample Apps** in your supported Web browser.
 
 The following section describes how to test your connection to the AT&T APIs using each Sample App.
 
@@ -14,13 +14,13 @@ A user accessing In-App Messaging features will be presented with a Consent Requ
 
 There are several authentication methods you may use, but the easiest and fastest method is using an AT&T device with an active wireless number, and send an authorization password to AT&T’s short code:
 
-![Oauth](resources/images/sample_apps_screens/oauth-one.png)
+![Oauth](/sdk/doc_src/resources/images/sample_apps_screens/oauth-one.png)
 
 When the correct password is received, you will see a screen like the following indicating that you have authorized the request:
 
-![Oauth](resources/images/sample_apps_screens/oauth-close.png)
+![Oauth](/sdk/doc_src/resources/images/sample_apps_screens/oauth-close.png)
 
-Make sure to select "Close window", because this way the user is redirected back to your application and the OAuth token is delivered to the server.
+Make sure to select "Close window" to redirect the user back to your app and deliver the OAuth token to the server.
 
 ##Speech File to Text
 Point your browser to this address: 
@@ -36,29 +36,29 @@ Point your browser to this address:
 
 Use the provided audio controls to record speech and submit the audio to view the resulting text from the AT&T Speech-to-Text API.
 
-Note that your browser must support current web audio standards in order to use this sample.
+Note that your browser must support current Web audio standards in order to use this sample.
 
 ##Text To Speech
 Point your browser to this address: 
 
     http://{yourdomain}:{port}/Speech/App3/index.html 
 
-Type English text into the provided text input area, and tap submit to send the test to the AT&T Text-to-Speech API. Tap **Play converted speech** to hear the resulting audio.
+Type English text into the provided text input area, and tap **Submit** to send the text to the AT&T Text-to-Speech API. Tap **Play converted speech** to hear the resulting audio.
 
 ##SMS
-This sample app demonstrates SMS messages sent from and to your application.
+This sample app demonstrates SMS messages sent from and to your app.
 
 Point your browser to this address: 
 
     http://{yourdomain}:{port}/SMS/App1/index.html 
 
-This sample application showcases three different features. The first one, allows the app to send a short message to a given phone number: enter the _Phone Number_ and the _Message_ and press the **Send Message** button. 
+This sample app showcases three different features. The first one sends a short message to a given phone number: enter the _Phone Number_ and the _Message_ and press the **Send Message** button. 
 
 After sending your message, you will see a screen showing the **Message ID** that corresponds to the sent message.
 
 To retrieve the status of the message, tap **Get Status**. 
 
-To check the messages sent to a specific short code, you must have at least one short code configured on your AT&T Developer Program application. To add a short code, open the configuration file at this location:  
+To check the messages sent to a specific short code, you must have at least one short code configured on your AT&T Developer Program app. To add a short code, open the configuration file at this location:  
 
 	/webcontent/SMS/App1/app/Config.js
 
@@ -82,9 +82,9 @@ Point your browser to this address:
 
     http://{yourdomain}:{port}/SMS/App2/index.html 
 
-This sample application demonstrates the callback functionality. In this sample, the app counts votes sent to a specific short code using specific test in the message body. 
+This sample app demonstrates the callback functionality. In this sample, the app counts votes sent to a specific short code using specific text in the message body. 
 
-To configure your short code on the application, open the configuration file at this location:  
+To configure your short code on the app, open the configuration file at this location:  
 
 	/webcontent/SMS/App2/app/Config.js
 
@@ -97,7 +97,7 @@ Configure the parameters for the short code:
 
 The app will count messages to the short code with the text **"Football"**, **"Basketball”**, or **"Baseball”**.
 
-**Note** Make sure to configure the callback for your short code so it points to:
+**Note:** Make sure to configure the callback for your short code so it points to:
 
 	http://{yourdomain}:{port}/att/sms/votelistener
 
@@ -108,7 +108,7 @@ Point your browser to this address:
 
     http://{yourdomain}:{port}/MMS/App1/index.html 
 
-This sample application sends a multimedia message to a given phone number. Enter the _Phone Number_ and the _Message_, select an image from the _Chose File_ menu and tap **Send Message**. 
+This sample application sends a multimedia message to a given phone number. Enter the _Phone Number_ and the _Message_, select an image from the _Choose File_ menu and tap **Send Message**. 
 
 After sending a message, the app displays a **Message ID** corresponding to the message sent.  To retrieve the status of the message, tap **Get Status**. 
 
@@ -131,7 +131,7 @@ Configure the parameters for the short code:
     shortCode         : 'your short code here'
 
 
-**Note** You must configure the callback for the short code in your application so that it points to this location:
+**Note:** You must configure the callback for the short code in your application so that it points to this location:
 
 	http://{yourdomain}:{port}/att/mms/gallerylistener
 

sdk/doc_src/guides/server_java/README.md

@@ -1,23 +1,23 @@
 HTML5 SDK Server (Java Implementation)
 ===
 
-This guide provides instructions for creating a Web application using Java. At the end of this guide you will have a Java Web application that can connect to the APIs provided by AT&T.
+This guide provides instructions for creating a Web app using Java. At the end of this guide you will have a Java Web app that can connect to the APIs provided by AT&T.
 
-To simplify the deployment of the SDK using Java, we have included an embedded Jetty servlet container.  The Java code is built using Apache Ant.
+To simplify the deployment of the SDK using Java, we have included an embedded Jetty servlet container. The Java code is built using Apache Ant.
 
 Prerequisites
 ----
 
  - Java version 1.6 or later. You can obtain this from [http://java.com](http://java.com).
- - Apache Ant version 1.8 or later
+ - Apache Ant version 1.8 or later.
 
  - Optional:
-   - Eclipse Integrated Development Environment (IDE) for Java Developers
+   - Eclipse Integrated Development Environment (IDE) for Java Developers.
 
 
-We have provided the .project and .classpath files that are needed to automatically create an Eclipse project. You can build and run the application using these files instead of using the command line instructions.
+We have provided the .project and .classpath files that are needed to automatically create an Eclipse project. You can build and run the app using these files instead of using the command line instructions.
 
-**Note:** Windows users follow the **Build and Run using Eclipse** instructions to build and run the SDK using Eclipse without needing to configure a command line environment.
+**Note:** Windows users follow the **Build and Run using Eclipse** instructions to build and run the SDK using Eclipse without needing to configure a command-line environment.
 
 Run the following commands to build and start the Java server:
 
@@ -27,7 +27,7 @@ Run the following commands to build and start the Java server:
     $ ant -version
     Apache Ant(TM) version 1.8.2 compiled on February 28 2011
 
-If you want to generate a .war file for deployment with a different servlet container, you can use the provided Ant build file.  If you deploy the .war into a path below root, modify the _serverUrl = "/att" variable in att-api-client.js to include your path.
+If you want to generate a .war file for deployment with a different servlet container, you can use the provided Ant build file. If you deploy the .war into a path below root, modify the _serverUrl = "/att" variable in att-api-client.js to include your path.
 
 Java Server Documentation
 ---
@@ -39,7 +39,7 @@ Server configuration
 Open the file sdk/server/java/conf/att-api.properties, find the following settings and customize them with the appropriate values:
 
     # Replace these values with App Key and Secret found in your 
-    # application
+    # app
     AppKey=XXXXXX
     Secret=XXXXXX
 
@@ -54,7 +54,7 @@ This SDK comes with a default set of self-signed certificates in the server/java
 
 Note: Since these default certificates are self-signed, you will see a certificate warning the first time you access an SSL link on the SDK server. You can either continue on through the warning, or purchase secure server certificates.
 
-A few of the samples demonstrate scenarios involving incoming notifications from AT&T, which require certificates whose domain name matches the actual name of the server hosting the samples. You can generate or obtain appropriate self-signed certificates or purchase registrar-signed certificates.  If you use your own certificate files, there are detailed instructions for generating an updated .keystore file in server/java/certs/readme.txt.
+A few of the samples demonstrate scenarios involving incoming notifications from AT&T, which require certificates whose domain name matches the actual name of the server hosting the samples. You can generate or obtain appropriate self-signed certificates or purchase registrar-signed certificates. If you use your own certificate files, there are detailed instructions for generating an updated .keystore file in server/java/certs/readme.txt.
 
 
 Command Line (Mac, Linux, Unix)
@@ -63,10 +63,10 @@ Command Line (Mac, Linux, Unix)
 Run using the command line
 ---
 
-Once you have compiled the source code and created a .war file, you can run the application using Jetty. To deploy the .war file in a different Java servlet container such as Tomcat, copy the .war file from dist/att.war into your servlet container's deployment directory and follow your vendor's instructions for deploying .war files.
+Once you have compiled the source code and created a .war file, you can run the app using Jetty. To deploy the .war file in a different Java servlet container such as Tomcat, copy the .war file from dist/att.war into your servlet container's deployment directory and follow your vendor's instructions for deploying .war files.
 
 
-To run the application, using the included Jetty server, use the included shell script, by typing the following at a command prompt in the sdk/server/java directory:
+To run the app using the included Jetty server, use the included shell script, by typing the following at a command prompt in the sdk/server/java directory:
 
     $ sh run.sh
 
@@ -78,7 +78,7 @@ You can also use the 'nohup' command to run the server in the background (<http:
 
     $ nohup sh run.sh &
 
-The application should now be running on http://yourhost:4567/
+The app should now be running on http://yourhost:4567/
 
 To change the port number, pass a different port as the first argument:
 
@@ -90,15 +90,15 @@ Stopping the server
 If you run the server as an interactive process you must end the process manually using control-c.
 If you use the 'nohup' command to run the server in the background, remember to manually end the process when you are done with it.
 
-**AT&T does not recommend deploying your application using the provided embedded Jetty server.** It should be used for development and testing purposes only.
-If you want your application to run for an extended period of time, we recommend deploying the application as a .war file. See "Deploy the .war File" below.
-That way you can take advantage of the deployment management options on your application server.
+**AT&T does not recommend deploying your app using the provided embedded Jetty server.** It should be used for development and testing purposes only.
+If you want your app to run for an extended period of time, we recommend deploying the app as a .war file. See "Deploy the .war File" below.
+That way you can take advantage of the deployment management options on your app server.
 
 
 Build using the command line (Apache Ant)
 ---
 
-To build the application using Ant from the command line:
+To build the app using Ant from the command line:
 
     $ sh build.sh
 
@@ -108,7 +108,7 @@ This command will create a directory called *dist*, as well the __att.jar__ and
 Eclipse IDE (Mac, Linux, Unix, Windows)
 ====
 
-Build and Run using Eclipse
+Build and run using Eclipse
 ---
 
 Start Eclipse and create a new project by choosing File->New->Project.
@@ -125,11 +125,11 @@ Start Eclipse and create a new project by choosing File->New->Project.
 
 Once the project is created it should build automatically without error.
 
-Using the package *explorer* expand com.html5sdk.jetty and open EmbeddedServer.
+Using the package *explorer*, expand com.html5sdk.jetty and open EmbeddedServer.
 
 From the Run menu, choose the Run command.
 
-The application should now be running on http://yourhost:4567/
+The app should now be running on http://yourhost:4567/
 
 When you are done using the server, stop the process using the Stop button from Eclipse's console view or debug view.
 
@@ -151,14 +151,14 @@ Deploy the .war File
 
 The Ant build.xml provided by the SDK creates a deployable .war file. It will bundle the client directory, java code, and the contents of **webapp/WEB-INF/**.
 
-**att-api.properties** will be copied to **WEB-INF/classes/**, so you need to configure your application before creating the build.
+**att-api.properties** will be copied to **WEB-INF/classes/**, so you must configure your app before creating the build.
 
 Follow the directions in **Build using the command line (Apache Ant)** and copy the **att.war** to your application server. Every application server deployment is different, but the build .war file is self-contained and should deploy on any standards-compliant application server.
 
 Alternate locations for att-api.properties
 ---
 
-To provide some flexibility in the application deployment, there are two ways to load the properties file. The default is to look on the classpath using the classloader for **att-api.properties.** You can override this behavior by specifying a Java system property. By specifying a system property, the application can be re-configured without recompiling the .war file.
+To provide some flexibility in deployment, there are two ways to load the properties file. The default is to look on the classpath using the classloader for **att-api.properties.** You can override this behavior by specifying a Java system property. By specifying a system property, the app can be re-configured without recompiling the .war file.
 
 **com.html5sdk.example.servlet.AttConstants** will look first for the system property **att.api.conf:**