From d3f9253ec6b2c87a8f35a2afe4c36b7537c23cbe Mon Sep 17 00:00:00 2001 From: Brian Date: Wed, 19 May 2010 00:28:13 -0400 Subject: [PATCH] Fixed README rendering issue and added a function that was previously missing in the documentation. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b530c85..1f480a6 100644 --- a/README.md +++ b/README.md @@ -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 "". **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 "<unknown>". **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. @@ -71,4 +71,6 @@ AsteriskManager Functions * **connect**() - _(void)_ - Attempts to connect to the asterisk server. -* **login**() - _(void)_ - Performs authentication. \ No newline at end of file +* **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. \ No newline at end of file