xendapp-client
v0.0.8
Published
XendApp Client Framework
Downloads
5
Maintainers
Readme
XendApp Client JS
What is XendApp?
XendApp is a service letting you send multiple content type messages to devices. A device could for example be a phone or tablet. More informations here : http://xendapp.com
How to install the module
You can clone this repo or use npm:
npm install xendapp-client
Functions
Send Message
Published specified message to channel.
xendapp.SendMessage(username, password, channelid, subject, message, contenttype, expirydate, callback, errorCallback)
Parameters:
- Username (string) : Sender's Uername.
- Password (string) : Sender's Password.
- ChannelId (string (guid)) : Channel Identificator
- Subject (string) : Message Subject
- Message (string) : Message Body
- ContentType (int (can be 1 or 2, 1 for PlainText, 2 for HTML)) : Content Type
- ExpiryDate (long (Unix Timestamp format)) : Expiry Date if set to 0, then by default equals to current date + 3 months.
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Delete Message
Deletes message (indicating that it was deleted from given device)
xendapp.DeleteMessage(username, password, deviceid, messageid, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- DeviceId (string (guid)) : Device Identificator
- MessageId (string (guid)) : Message Identificator
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get Full Message
Gets full message
xendapp.GetFullMessage(username, password, deviceid, messageid, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- DeviceId (string (guid)) : Device Identificator
- MessageId (string (guid)) : Message Identificator
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get Message Recipients Counts
Get count of users and devices, which must receive message from specified channel
xendapp.GetMessageRecipientsCounts(username, password, channelid, callback, errorCallback)
Parameters:
- Username (string) : Sender's Uername.
- Password (string) : Sender's Password.
- ChannelId (string (guid)) : Channel Identificator
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get Inbox
Gets inbox by user
xendapp.GetInbox(username, password, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get Sentbox
Gets sentbox by user
xendapp.GetSentbox(username, password, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get User Channels
Gets user's subscriptions grouped by provider.
xendapp.GetUserChannels(username, password, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
Get User Providers With Channels
Gets user's channels grouped by provider.
xendapp.GetUserProvidersWithChannels(username, password, callback, errorCallback)
Parameters:
- Username (string) : User's Uername.
- Password (string) : User's Password.
- Callback (function(e) (Where e is the server response))
- ErrorCallback (function(e) (Where e is the server response))
License
Valentin Michalak, claim no copyright and release my code into the public domain using the CC0 license. For additional information please see the link below.
http://creativecommons.org/publicdomain/zero/1.0/
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.