Registers a repository app as an SMS provider, by declaring the function names used to send a message and to supply the provider's settings. Started from ControllerMappingList.smsProviderDetails(). Call build() to construct the resulting SmsProviderDetails and store it on the target ControllerMappingList, from where RepositoryApp reads it to send messages and expose settings.
Group: Builders
Properties
| Property | Returns | Description |
|---|---|---|
| sendSmsFn | String | Name of the function currently configured to send an SMS message. |
| settingsFn | String | Name of the function currently configured to populate the SMS provider's settings. |
Methods
getSendSmsFn()
Returns: String
Name of the function currently configured to send an SMS message.
setSendSmsFn(String sendSmsFn)
Returns: void
Sets the name of the function invoked to send an SMS message.
| Parameter | Description |
|---|---|
sendSmsFn | the name of the function to invoke to send a message |
sendSmsFn(String sendSmsFn)
Returns: SmsProviderDetailsBuilder
Sets the name of the function invoked to send an SMS message.
| Parameter | Description |
|---|---|
sendSmsFn | the name of the function to invoke to send a message |
getSettingsFn()
Returns: String
Name of the function currently configured to populate the SMS provider's settings.
setSettingsFn(String settingsFn)
Returns: void
Sets the name of the function invoked to populate the SMS provider's settings for an organisation.
| Parameter | Description |
|---|---|
settingsFn | the name of the function to invoke to populate the settings |
settingsFn(String settingsFn)
Returns: SmsProviderDetailsBuilder
Sets the name of the function invoked to populate the SMS provider's settings for an organisation.
| Parameter | Description |
|---|---|
settingsFn | the name of the function to invoke to populate the settings |
build()
Returns: void
Finishes this builder, constructing an SmsProviderDetails from the configured function names and storing it on the target ControllerMappingList. Logs a warning if no send SMS function was set, since the app would then be unable to send messages.