Skip to content

Commit

Permalink
Fixed README rendering issue and added a function that was previously…
Browse files Browse the repository at this point in the history
… missing in the documentation.
  • Loading branch information
mscdex committed May 19, 2010
1 parent 13e302e commit d3f9253
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -21,7 +21,7 @@ node-asterisk exposes only one class: **AsteriskManager**.
#### Data types

* _Participant_ is an object currently containing the following properties:
* **name** - A String containing the name provided by Caller ID, if it's not available/provided then it's set to "<unknown>". **Note:** Caller ID _name_ information is only available once a call is connected.
* **name** - A String containing the name provided by Caller ID, if it's not available/provided then it's set to "&lt;unknown&gt;". **Note:** Caller ID _name_ information is only available once a call is connected.
* **number** - An Integer representing a 10-digit (PSTN) landline number or an asterisk extension.
* **with** - An Integer representing a unique number identifying another Participant they are associated with. **Note:** this property is not set until the _dialing_ event occurs.

Expand Down Expand Up @@ -71,4 +71,6 @@ AsteriskManager Functions

* **connect**() - _(void)_ - Attempts to connect to the asterisk server.

* **login**() - _(void)_ - Performs authentication.
* **login**() - _(void)_ - Performs authentication.

* **getParticipant**(String) - _Participant_ - Retrieves the Participant with the specified unique id. For now, these ids only exist in the _with_ property of Participant. **Note:** Participants are non-existant after the appropriate _callreport_ event is fired.

0 comments on commit d3f9253

Please sign in to comment.