otr4/lib/Contact.js

OTR Messaging Protocol [native libotr4.x.x]

var libotr = require("../build/Release/otrnat");
var otr = require("../index.js");

module.exports.Contact = Contact;

/** Contact
 * @constructor
 * @alias module:otr.Contact
 * @argument {User} user - instance of {@link module:otr.User User}
 * @argument {Account} account - instance of {@link module:otr.Account Account}
 * @argument {string} name - Name of contact
 */
function Contact(user, account, name) {
	if (!(user instanceof otr.User)) {
		throw new TypeError("first argument must be an instance of User");
	}
	if (!(account instanceof otr.Account)) {
		throw new TypeError("second argument must be an instance of Account");
	}
	if (typeof name !== 'string') {
		throw new TypeError("third argument must be a string");
	}

	/** Getter for name of contact
	 *  @method
	 *  @returns {string} contact name
	 */
	this.name = function () {
		return name;
	};

	/** Returns an array of known Fingerprint instances for this contact.
	 *  @method
	 *  @returns {array} Array of Fingerprint instances.
	 */
	this.fingerprints = function () {
		var context = new libotr.ConnContext(user.state, account.name(), account.protocol(), name);
		return context.masterFingerprints();
	};

	/** Deletes the contact, so long as any sessions with this contact are in PLAINTEXT.
	 *  @method
	 *  @return {bool} true if deleted successfully.
	 */
	this.delete = function () {
		var context = new libotr.ConnContext(user.state, account.name(), account.protocol(), name);
		return context.master().forget() === 0; //return true if successfully deleted
	};

	/** Setup an OTR session with the contact.
	 *  @method
	 *  @argument {Object} [parameters]
	 *  @returns {Session} new instance of {@link module:otr.Session Session}
	 */
	this.openSession = function (parameters) {
		return new otr.Session(user, account, this, parameters);
	};

}