pip_services_smssettings 1.1.0

SMS Settings microservice for Pip.Services in Dart. This microservice keeps settings of sms recipients.

example/README.md

Examples for Sms Settings Microservice

This is a sms settings microservice from Pip.Services library. This microservice keeps settings of sms recipients.

Define configuration parameters that match the configuration of the microservice's external API

// Service/Client configuration
var httpConfig = ConfigParams.fromTuples([
	"connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080
]);

Instantiate the service

persistence = SmsSettingsMemoryPersistence();
persistence.configure(ConfigParams());

controller = SmsSettingsController();
controller.configure(ConfigParams());

service = SmsSettingsHttpServiceV1();
service.configure(httpConfig);

var references = References.fromTuples([
    Descriptor('pip-services-smssettings', 'persistence', 'memory',
        'default', '1.0'),
    persistence,
    Descriptor('pip-services-smssettings', 'controller', 'default',
        'default', '1.0'),
    controller,
    Descriptor(
        'pip-services-smssettings', 'service', 'http', 'default', '1.0'),
    service
]);

controller.setReferences(references);
service.setReferences(references);

await persistence.open(null);
await service.open(null);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = SmsSettingsHttpClientV1(config);

// Configure the client
client.configure(httpConfig);

// Connect to the microservice
try{
  await client.open(null)
}catch() {
  // Error handling...
}       
// Work with the microservice
// ...

Now the client is ready to perform operations

// Create a new settings
final SETTINGS = SmsSettingsV1(
    id: '1',
    name: 'User 1',
    phone: '[phone]',
    language: 'en',
    verified: false);

    // Create the settings
    try {
      var settings = await client.setSettings('123', SETTINGS);
      // Do something with the returned settings...
    } catch(err) {
      // Error handling...     
    }

// Get the settings
try {
var settings = await client.getSettingsByPhoneSettings(
    null,
    '[phone]');
    // Do something with settings...

    } catch(err) { // Error handling}

// Verify an sms
try {
    settings1 = SETTINGS;
    settings1.ver_code = '123';  
    await controller.verifyPhone(null, '1', '123');

    var settings = await client.getSettingsByPhoneSettings(
    null,
    '[phone]');
    // Do something with settings...

    } catch(err) { // Error handling}

In the help for each class there is a general example of its use. Also one of the quality sources are the source code for the tests.