react-native-xsip/src/Account.ts

PJSIP module for React Native

import AccountRegistration from './AccountRegistration'

export type AccountConfiguration = {
    id: number,
    uri: string,
    name: string,
    username: string,
    domain: string | null,
    password: string,
    proxy: string,
    transport: string,
    contactParams: string,
    contactUriParams: string,
    regServer: string,
    regTimeout: string,
    regContactParams: string,
    regHeaders: Object
};

/**
 * This describes account configuration and registration status
 */
export default class Account {
    _data: AccountConfiguration;
    _registration: AccountRegistration;

    constructor(data: any) {
        this._data = data;
        this._registration = new AccountRegistration(data['registration']);
    }

    /**
     * The account ID.
     * @returns {int}
     */
    getId(): number {
        return this._data.id;
    }

    /**
     * This is the URL to be put in the request URI for the registration, and will look something like "sip:serviceprovider".
     * @returns {String}
     */
    getURI(): string {
        return this._data.uri;
    }

    /**
     * Full name specified in Endpoint.createAccount().
     * @returns {String}
     */
    getName(): string {
        return this._data.name;
    }

    /**
     * Username specified in Endpoint.createAccount().
     * @returns {String}
     */
    getUsername(): string {
        return this._data.username;
    }

    /**
     * Domain specified in Endpoint.createAccount().
     * @returns {int|null}
     */
    getDomain(): string | null {
        return this._data.domain;
    }

    /**
     * Password specified in Endpoint.createAccount().
     * @returns {String}
     */
    getPassword(): string {
        return this._data.password;
    }

    /**
     * Proxy specified in Endpoint.createAccount().
     * @returns {String}
     */
    getProxy(): string {
        return this._data.proxy;
    }

    /**
     * Transport specified in Endpoint.createAccount().
     * @returns {String}
     */
    getTransport(): string {
        return this._data.transport;
    }

    /**
     * Additional parameters that will be appended in the Contact header
     * for this account.
     * @returns {String}
     */
    getContactParams(): string {
        return this._data.contactParams;
    }

    /**
     * Additional URI parameters that will be appended in the Contact URI
     * for this account.
     * @returns {String}
     */
    getContactUriParams(): string {
        return this._data.contactUriParams;
    }

    /**
     * Port specified in Endpoint.createAccount().
     * @returns {String}
     */
    getRegServer(): string {
        return this._data.regServer || "";
    }

    /**
     * Port specified in Endpoint.createAccount().
     * @returns {String}
     */
    getRegTimeout(): string {
        return this._data.regTimeout;
    }

    /**
     * @returns {String}
     */
    getRegContactParams(): string {
        return this._data.regContactParams;
    }

    /**
     * @returns {Object}
     */
    getRegHeaders(): Object {
        return this._data.regHeaders;
    }

    /**
     * Account registration status.
     * @returns {AccountRegistration}
     */
    getRegistration(): AccountRegistration {
        return this._registration;
    }
}