mirror of
https://github.com/cwinfo/envayasms.git
synced 2025-01-09 20:05:38 +00:00
document log parameter, device_status action for 2.0.1
This commit is contained in:
Jesse Young
parent
e26c446e8a
commit
e2b3c2732b
@ -2,6 +2,19 @@ id: history
|
||||
title: History
|
||||
---
|
||||
|
||||
Version 2.0.1 (2011/10/10)
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
Send EnvayaSMS log messages to server via <code>log</code> parameter
|
||||
</li>
|
||||
<li>
|
||||
Notify server of changes in the Android device's power/battery state
|
||||
via <code>device_status</code> action.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
Version 2.0 (2011/10/01)
|
||||
|
||||
<ul>
|
||||
|
||||
@ -201,7 +201,18 @@ The following parameters are sent in all POST requests from EnvayaSMS:
|
||||
are running EnvayaSMS.
|
||||
</dd>
|
||||
|
||||
<dt>"action" ::= "outgoing" | "incoming" | "send_status" | "test"</dt>
|
||||
<dt>"log" ::= <text></dt>
|
||||
<dd>
|
||||
Log messages printed to the EnvayaSMS console since the last successful HTTP request.
|
||||
<br /><br />
|
||||
You may wish to append this data to a log file to allow administrators
|
||||
to see error details without needing physical access to the phone.
|
||||
<br /><br />
|
||||
EnvayaSMS does not guarantee that the server receives log messages in order. Occasionally,
|
||||
the server may receive the same log message multiple times.
|
||||
</dd>
|
||||
|
||||
<dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
|
||||
<dd>
|
||||
The request action determines the purpose of the HTTP request:
|
||||
|
||||
@ -221,10 +232,16 @@ The following parameters are sent in all POST requests from EnvayaSMS:
|
||||
Update the server on the status of sending an outgoing message
|
||||
</dd>
|
||||
|
||||
<dt>"device_status":</dt>
|
||||
<dd>
|
||||
Notify the server of a change in the Android device's state.
|
||||
</dd>
|
||||
|
||||
<dt>"test":</dt>
|
||||
<dd>
|
||||
Test the server connection.
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
@ -360,6 +377,39 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Additional parameters sent in POST requests with <code>action=device_status</code>:
|
||||
|
||||
<dl>
|
||||
<dt>"status" ::= "power_connected" | "power_disconnected" <br />
|
||||
| "battery_low" | "battery_okay"</dt>
|
||||
<dd>
|
||||
This field describes a condition that has changed on the Android device.
|
||||
|
||||
<dl>
|
||||
<dt>"power_connected":</dt>
|
||||
<dd>
|
||||
The phone is now connected to external power.
|
||||
</dd>
|
||||
|
||||
<dt>"power_disconnected":</dt>
|
||||
<dd>
|
||||
This phone is no longer connected to external power.
|
||||
</dd>
|
||||
|
||||
<dt>"battery_low":</dt>
|
||||
<dd>
|
||||
The phone's battery level has dropped below 15%.
|
||||
</dd>
|
||||
|
||||
<dt>"battery_okay":</dt>
|
||||
<dd>
|
||||
The phone's battery level is now at least 20% (after dropping below 15%).
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h3>
|
||||
HTTP Response Format
|
||||
</h4>
|
||||
|
||||
@ -23,8 +23,7 @@ The following steps explain how to set up EnvayaSMS on an Android Virtual Device
|
||||
<small>Note: Android Market does not work in the emulator.</small></li>
|
||||
<li>Install EnvayaSMS</li>
|
||||
<li>Configure EnvayaSMS with the settings of your development server. <br />
|
||||
<small>Note: Do not enter <code>localhost</code> as the Server URL (since this would refer to the AVD itself). Instead, use your computer's IP address on the local network, as shown by the <code>ipconfig</code>
|
||||
or <code>ifconfig</code> utilities.</small>
|
||||
<small>Note: Use <code>10.0.2.2</code> as the host in the Server URL. Do not enter <code>localhost</code>, since this would refer to the AVD itself).</small>
|
||||
</li>
|
||||
<li>
|
||||
To simulate incoming SMS on the emulator:
|
||||
|
||||
@ -42,6 +42,19 @@
|
||||
<h2>History</h2>
|
||||
|
||||
|
||||
Version 2.0.1 (2011/10/10)
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
Send EnvayaSMS log messages to server via <code>log</code> parameter
|
||||
</li>
|
||||
<li>
|
||||
Notify server of changes in the Android device's power/battery state
|
||||
via <code>device_status</code> action.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
Version 2.0 (2011/10/01)
|
||||
|
||||
<ul>
|
||||
|
||||
@ -241,7 +241,18 @@ The following parameters are sent in all POST requests from EnvayaSMS:
|
||||
are running EnvayaSMS.
|
||||
</dd>
|
||||
|
||||
<dt>"action" ::= "outgoing" | "incoming" | "send_status" | "test"</dt>
|
||||
<dt>"log" ::= <text></dt>
|
||||
<dd>
|
||||
Log messages printed to the EnvayaSMS console since the last successful HTTP request.
|
||||
<br /><br />
|
||||
You may wish to append this data to a log file to allow administrators
|
||||
to see error details without needing physical access to the phone.
|
||||
<br /><br />
|
||||
EnvayaSMS does not guarantee that the server receives log messages in order. Occasionally,
|
||||
the server may receive the same log message multiple times.
|
||||
</dd>
|
||||
|
||||
<dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
|
||||
<dd>
|
||||
The request action determines the purpose of the HTTP request:
|
||||
|
||||
@ -261,10 +272,16 @@ The following parameters are sent in all POST requests from EnvayaSMS:
|
||||
Update the server on the status of sending an outgoing message
|
||||
</dd>
|
||||
|
||||
<dt>"device_status":</dt>
|
||||
<dd>
|
||||
Notify the server of a change in the Android device's state.
|
||||
</dd>
|
||||
|
||||
<dt>"test":</dt>
|
||||
<dd>
|
||||
Test the server connection.
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
@ -400,6 +417,39 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Additional parameters sent in POST requests with <code>action=device_status</code>:
|
||||
|
||||
<dl>
|
||||
<dt>"status" ::= "power_connected" | "power_disconnected" <br />
|
||||
| "battery_low" | "battery_okay"</dt>
|
||||
<dd>
|
||||
This field describes a condition that has changed on the Android device.
|
||||
|
||||
<dl>
|
||||
<dt>"power_connected":</dt>
|
||||
<dd>
|
||||
The phone is now connected to external power.
|
||||
</dd>
|
||||
|
||||
<dt>"power_disconnected":</dt>
|
||||
<dd>
|
||||
This phone is no longer connected to external power.
|
||||
</dd>
|
||||
|
||||
<dt>"battery_low":</dt>
|
||||
<dd>
|
||||
The phone's battery level has dropped below 15%.
|
||||
</dd>
|
||||
|
||||
<dt>"battery_okay":</dt>
|
||||
<dd>
|
||||
The phone's battery level is now at least 20% (after dropping below 15%).
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h3>
|
||||
HTTP Response Format
|
||||
</h4>
|
||||
|
||||
@ -63,8 +63,7 @@ The following steps explain how to set up EnvayaSMS on an Android Virtual Device
|
||||
<small>Note: Android Market does not work in the emulator.</small></li>
|
||||
<li>Install EnvayaSMS</li>
|
||||
<li>Configure EnvayaSMS with the settings of your development server. <br />
|
||||
<small>Note: Do not enter <code>localhost</code> as the Server URL (since this would refer to the AVD itself). Instead, use your computer's IP address on the local network, as shown by the <code>ipconfig</code>
|
||||
or <code>ifconfig</code> utilities.</small>
|
||||
<small>Note: Use <code>10.0.2.2</code> as the host in the Server URL. Do not enter <code>localhost</code>, since this would refer to the AVD itself).</small>
|
||||
</li>
|
||||
<li>
|
||||
To simulate incoming SMS on the emulator:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user