From wiki.ginstr.com
Jump to: navigation, search
m (formatting)
Line 8: Line 8:
 
==Action signatures==
 
==Action signatures==
  
=== ===
+
===Send SMS===
  
;<code>[gn:act_smsSend]|[to{n},message{n},repeat,timeout,successMessage{n},failMessage{n}]</code>
+
:;<code>[gn:act_smsSend]|[to{n},message{n},repeat,timeout,successMessage{n},failMessage{n}]</code>
  
{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
+
:{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
 
|-
 
|-
 
! scope="col" | Parameter
 
! scope="col" | Parameter
 
! scope="col" | Description
 
! scope="col" | Description
 
|-
 
|-
| to{n}
+
| <code>to{n}</code>
 
| [[source]] from where the value for recipient phone number will be used
 
| [[source]] from where the value for recipient phone number will be used
 
* Valid [[source|sources]]:
 
* Valid [[source|sources]]:
 
** any [[source]]
 
** any [[source]]
 
|-
 
|-
| message{n}
+
| <code>message{n}</code>
| [[source]] from where the value for sms message will be used
+
| [[source]] from where the value for SMS message will be used
 
* Valid [[source|sources]]:
 
* Valid [[source|sources]]:
 
** any [[source]]
 
** any [[source]]
 
|-
 
|-
| repeat
+
| <code>repeat</code>
| number which represents a number of sms sending repetitions  
+
| number which represents a number of SMS sending repetitions  
 
|-
 
|-
| timeout
+
| <code>timeout</code>
| time in miliseconds which will be used as timeout between sms sending repetitions  
+
| time in miliseconds which will be used as timeout between SMS sending repetitions  
 
|-
 
|-
| successMessage{n}
+
| <code>successMessage{n}</code>
 
| [[source]] from where the value for the success message will be used
 
| [[source]] from where the value for the success message will be used
 
* Valid [[source|sources]]:
 
* Valid [[source|sources]]:
 
** any [[source]]
 
** any [[source]]
 
|-
 
|-
| failMessage{n}
+
| <code>failMessage{n}</code>
 
| [[source]] from where the value for the fail message will be used
 
| [[source]] from where the value for the fail message will be used
 
* Valid [[source|sources]]:
 
* Valid [[source|sources]]:
Line 46: Line 46:
  
 
====Example====
 
====Example====
<code>@variable/alert_resident_smsForAlerts</code> - recipient phone muber<br>
+
:<code>@variable/alert_resident_smsForAlerts</code> - recipient phone number<br>
<code>@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName</code> - SMS message<br>
+
:<code>@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName</code> - SMS message<br>
<code>5</code> - number of repetitions<br>
+
:<code>5</code> - number of repetitions<br>
<code>30000</code> - timeout<br>
+
:<code>30000</code> - timeout<br>
<code>@+id/resident_alertConfirmationMessage</code> - success message<br>
+
:<code>@+id/resident_alertConfirmationMessage</code> - success message<br>
<code>@string/alerting_alertingFailedMessage1</code> - fail message<br><br>
+
:<code>@string/alerting_alertingFailedMessage1</code> - fail message<br>
<code>[gn:act_smsSend]|[@variable/alert_resident_smsForAlerts,@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName,5,30000,@+id/resident_alertConfirmationMessage,@string/alerting_alertingFailedMessage1]</code>
+
:; ⤷ <code>[gn:act_smsSend]|[@variable/alert_resident_smsForAlerts,@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName,5,30000,@+id/resident_alertConfirmationMessage,@string/alerting_alertingFailedMessage1]</code>
 
<hr>
 
<hr>

Revision as of 14:21, 12 July 2017

gn:act_smsSend

Description
Action used to send an SMS message to multiple recipients.
Action returns
boolean

Action signatures

Send SMS

[gn:act_smsSend]|[to{n},message{n},repeat,timeout,successMessage{n},failMessage{n}]
Parameter Description
to{n} source from where the value for recipient phone number will be used
message{n} source from where the value for SMS message will be used
repeat number which represents a number of SMS sending repetitions
timeout time in miliseconds which will be used as timeout between SMS sending repetitions
successMessage{n} source from where the value for the success message will be used
failMessage{n} source from where the value for the fail message will be used

Example

@variable/alert_resident_smsForAlerts - recipient phone number
@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName - SMS message
5 - number of repetitions
30000 - timeout
@+id/resident_alertConfirmationMessage - success message
@string/alerting_alertingFailedMessage1 - fail message
[gn:act_smsSend]|[@variable/alert_resident_smsForAlerts,@+id/alert_phone_serialNumber; ;@+id/emptySpace; ;@variable/alert_resident_firstName; ;@+id/emptySpace; ;@variable/alert_resident_lastName,5,30000,@+id/resident_alertConfirmationMessage,@string/alerting_alertingFailedMessage1]