@meecode/ng112-reg-js v2.0.4

ng112-reg-js

Table of Contents

• Installation
• Exposed Classes
• Prerequisites
• Usage
  • Registration Client
    • Initializing the registration client
    • Register a device
    • Error Handling
• Methods & Properties
  • DEC112RegistrationClient
    • Constructor
    • UpdateRegistrationServer
    • GetConfiguration
    • GetRootConfiguration
    • Register
    • CheckRegistration
    • ResendPhoneVerificationCode
    • Unregister
    • VerifyPhoneNumber
    • EnableDebug
    • IsDebugEnabled
  • PhoneVerificationData
  • RegistrationData
  • RegistrationInformationData
  • RequestDataError
  • Registration
  • DeleteRegistration
  • AppConfiguration
  • AppServices
  • AppService
  • RootConfiguration
  • Settings
  • SettingsInvalidError
  • NormalizePhoneNumberData
  • NormalizedPhoneNumber
  • CheckRegistrationData
  • ResendVerificationCode
  • RegistrationEndpoint
  • CountryRegistrationEndpoint
  • RequestError
  • RegistrationState
  • InAppSearch
  • InAppSearchItem

Installation

npm install @meecode/ng112-reg-js

Exposed Classes

• DEC112RegistrationClient
• AppConfiguration
• AppServices
• AppService
• App
• DeleteRegistration
• DeleteRegistrationData
• NormalizePhoneNumberData
• NormalizedPhoneNumber
• Notification
• PhoneVerificationData
• Registration
• RegistrationData
• RegistrationInformationData
• RegistrationState
• CheckRegistrationData
• ResendPhoneVerificationCodeData
• ResendVerificationCode
• RequestDataError
• RequestError
• RootConfiguration
• RegistrationEndpoint
• CountryRegistrationEndpoint
• Settings
• SettingsInvalidError
• Service
• EmergencyService
• Message
• Category
• DefaultMessages
• SilentMessages

Prerequisites

• Valid API Key
• Registration service URL

Usage

Be aware that the import syntax depends on the environment you are using

Registration Client

Initializing the registration client

import { DEC112RegistrationClient, Settings } from '@meecode/ng112-reg-js/dist/node';

const registrationServer = 'https://your-registration-server-url/api/apiVersion';
const apiKey = 'yourApiKey';

const settings: Settings = new Settings(registrationServer, apiKey);
const instance = new DEC112RegistrationClient(settings);

Register a device

Follow these steps to register a device:

The registrationId is very important and needs to be stored in order to send other queries. There is no possibility on recover a lost registrationId.

import { RegistrationData, Registration } from '@meecode/ng112-reg-js/dist/node';

const registrationServer = 'https://your-registration-server-url/api/apiVersion';
const apiKey = 'yourApiKey';
const settings: Settings = new Settings(registrationServer, apiKey);
const instance = new DEC112RegistrationClient(settings);

const normalizePhoneNumberData = new NormalizePhoneNumberData('066475007205', '0042');
const response = await instance.normalizePhoneNumber(normalizePhoneNumberData);

const registrationData = new RegistrationData('iPhone XS', 'en', response.normalizedPhoneNumber);
const registrationResponse = await instance.register(registrationData);

const phoneVerificationData = new PhoneVerificationData("4444-1111", registrationResponse.registrationId);
const verifyPhoneResponse = await instance.verifyPhoneNumber(phoneVerificationData);

const registrationInformationData = new RegistrationInformationData(registrationResponse.registrationId);
const deviceConfiguration = await instance.getConfiguration();

Error Handling

Every method returns Readonly<RequestError> in case one or more errors occur.

import { RegistrationData, Registration } from '@meecode/ng112-reg-js/dist/node';

const registrationServer = 'https://your-registration-server-url/api/apiVersion';
const apiKey = 'yourApiKey';
const settings: Settings = new Settings(registrationServer, apiKey);
const instance = new DEC112RegistrationClient(settings);

const registrationData = new RegistrationData('iPhone XS', 'en', '000011112222');
const registrationResponse = instance.register(registrationData)
    .catch((error: Readonly<RequestError>) => {
        //TODO: implement
    });

Usage in combination with ng112-js SDK

Query the app configuration after successful registration

import {
    Agent,
    DEC112Specifics,
} from 'ng112-js/dist/node';

const registrationServer = 'https://your-registration-server-url/api/apiVersion';
const apiKey = 'yourApiKey';
const settings: Settings = new Settings(registrationServer, apiKey);
const instance = new DEC112RegistrationClient(settings);
const registrationInformationData = new RegistrationInformationData('registrationId');

const configuration = await instance.getConfiguration(registrationInformationData);

const agenConfiguration = {
    endpoint: configuration.server,
    domain: configuration.realm,
    user: configuration.privateId,
    password: configuration.password,
    displayName: 'Your display name',
    namespaceSpecifics: new DEC112Specifics(undefined, configuration.registrationId, 'your language')
};
const agent = new Agent(agenConfiguration);

// Choose the appropriate service from the array of available services and use the sip property as conversation partner
const conversationPartner = configuration.services.default[0].sip;

agent.createConversation(conversationPartner);

Methods & Properties

DEC112RegistrationClient

The DEC112RegistrationClient is used to communicate with the corresponding registration service.

Constructor

constructor(settings)

UpdateRegistrationServer

Update the registration server

updateRegistrationServer(registrationServer)

GetConfiguration

Get the configuration for an already existing registration. The configuration can change, so it is recommended to check periodically if the configuration has changed.

getConfiguration(registrationInfo)

Returns a Promise which resolves with Readonly<AppConfiguration> when successful and rejects with Readonly<RequestError> when an error occurred.

GetRootConfiguration

The root configuration provides a list of DEC112 registries and other resources (e.g. language resources). Select the registry which should be used for the registration process.

getRootConfiguration()

No parameters required.

Returns a Promise which resolves with Readonly<RootConfiguration> when successful and rejects with Readonly<RequestError> when an error occurred.

NormalizePhoneNumber

normalizePhoneNumber(phoneNumberData)

Returns a Promise which resolves with Readonly<NormalizedPhoneNumber> when successful and rejects with Readonly<RequestError> when an error occurred.

Register

Register a new user with the given registration information.

register(registrationData)

Returns a Promise which resolves with Readonly<Registration> when successful and rejects with Readonly<RequestError> when an error occurred.

CheckRegistration

Check the registration data of an existing registration. Can also be used to check the registration state (e.g.: pending, ...)

Returns a Promise which resolves with Readonly<Registration> when successful and rejects with Readonly<RequestError> when an error occurred.

ResendPhoneVerificationCode

Allows resending a possibly lost phone verification SMS code up to two times.

resendPhoneVerificationCode(rendCodeData)

Returns a Promise which resolves with Readonly<ResendVerificationCode> when successful and rejects with Readonly<RequestError> when an error occurred.

Unregister

Deletes an existing Registration.

unregister(deleteRegistrationData)

Returns a Promise which resolves with Readonly<DeleteRegistration> when successful and rejects with Readonly<RequestError> when an error occurred.

VerifyPhoneNumber

Verifies a registrations phone number.

verifyPhoneNumber(verificationData)

Returns a Promise which resolves with Readonly<Registration> when successful and rejects with Readonly<RequestError> when an error occurred.

EnableDebug

Enables the debug mode which outputs also debug statements to the console.

enableDebug(true)

IsDebugEnabled

Checks whether the debug mode is enabled or not.

isDebugEnabled()

PhoneVerificationData

RegistrationData

SaveRegistrationData

RegistrationInformationData

DeleteRegistrationData

RequestDataError

Registration

DeleteRegistration

AppConfiguration

Response of getConfiguration request

AppServices

RootConfiguration

Settings

SettingsInvalidError

NormalizePhoneNumberData

NormalizedPhoneNumber

CheckRegistrationData

ResendPhoneVerificationCodeData

Response of ResendPhoneVerificationCode request.

ResendVerificationCode

Request data for the ResendPhoneVerificationCode request.

RegistrationEndpoint

CountryRegistrationEndpoint

RequestError

RegistrationState

Enum for the different registration states. Every value between 2 - 8 means ongoing verification process.

Service

Emergency service configuration

EmergencyService

Message

Category

DefaultMessages

SilentMessages

EmergencyCategory

TestCategory

Translations

Translations object

App

App specific configuration

Notification

Notification specific configuration

InAppSearch

InAppSearchItem

Author

MeeCode by Mario Murrent

Special Thanks

For supporting the development:

Gebsl

License

UNLICENSED

Copyright

Copyright © 2021 - 2023, MeeCode by Mario Murrent. All Rights Reserved.

CI Status