#include <account_config.h>

Inheritance diagram for jami::AccountConfig:

Collaboration diagram for jami::AccountConfig:

Public Member Functions
	AccountConfig (const std::string &type_, const std::string &id_, const std::filesystem::path &path_={})

virtual void	fromMap (const std::map< std::string, std::string > &)

virtual void	serialize (YAML::Emitter &out) const =0

void	serializeDiff (YAML::Emitter &out, const AccountConfig &def) const

virtual std::map< std::string, std::string >	toMap () const

virtual void	unserialize (const YAML::Node &node)

Public Member Functions inherited from jami::Serializable
virtual	~Serializable ()

Public Attributes
int	activeCallLimit {-1}
	The number of concurrent calls for the account -1: Unlimited 0: Do not disturb 1: Single call +: Multi line.

std::vector< unsigned >	activeCodecs {}

std::string	alias {}
	A user-defined name for this account.

bool	allModeratorsEnabled {true}

bool	autoAnswerEnabled {false}
	If true, automatically answer calls to this account.

std::string	customUserAgent {}
	User-agent used for registration.

std::set< std::string >	defaultModerators {}

bool	denySecondCallEnabled {false}
	If true, automatically deny new calls when already in one call to this account.

std::string	deviceKey {}
	Device push notification token.

std::string	displayName {}
	Display name when calling.

bool	enabled {true}
	True if the account is enabled.

std::string	hostname {}
	SIP hostname (SIP account) or DHT bootstrap nodes (Jami account)

const std::string	id
	Account id.

bool	isRendezVous {false}
	If true mix calls into a conference.

bool	localModeratorsEnabled {true}

std::string	mailbox {}
	Account mail box.

std::string	notificationTopic {}
	Push notification topic.

const std::filesystem::path	path
	Path where the configuration file is stored.

std::string	platform {}
	Device push notification platform.

bool	ringtoneEnabled {true}
	Play ringtone when receiving a call.

std::string	ringtonePath {DEFAULT_RINGTONE_PATH}
	Ringtone file used for this account.

bool	sendComposing {true}
	If true, send composing status (and emit to the client)

bool	sendReadReceipt {true}
	If true, send displayed status (and emit to the client)

const std::string	type
	Account type.

std::string	uiCustomization {}
	information about the customization of ui

bool	upnpEnabled {true}
	UPnP IGD controller and the mutex to access it.

std::string	username {}

bool	videoEnabled {true}
	Allows user to temporarily disable video calling.

Detailed Description

Definition at line 31 of file account_config.h.

Constructor & Destructor Documentation

◆ AccountConfig()

jami::AccountConfig::AccountConfig	(	const std::string &	type_,
		const std::string &	id_,
		const std::filesystem::path &	path_ = `{}`
	)

inline

Definition at line 33 of file account_config.h.

Member Function Documentation

◆ fromMap()

void jami::AccountConfig::fromMap ( const std::map< std::string, std::string > & details )

virtual

Reimplemented in jami::JamiAccountConfig, jami::SipAccountConfig, and jami::SipAccountBaseConfig.

Definition at line 157 of file account_config.cpp.

Referenced by jami::SipAccountBaseConfig::fromMap().

Here is the call graph for this function:

◆ serialize()

virtual void jami::AccountConfig::serialize ( YAML::Emitter & out ) const

pure virtual

Implements jami::Serializable.

Implemented in jami::JamiAccountConfig, and jami::SipAccountConfig.

◆ serializeDiff()

void jami::AccountConfig::serializeDiff	(	YAML::Emitter &	out,
		const AccountConfig &	def
	)		const

Definition at line 59 of file account_config.cpp.

References jami::ACCOUNT_ACTIVE_CALL_LIMIT_KEY, jami::ACCOUNT_AUTOANSWER_KEY, jami::ACCOUNT_COMPOSING_KEY, jami::ACCOUNT_ENABLE_KEY, jami::ACCOUNT_ISRENDEZVOUS_KEY, jami::ACCOUNT_READRECEIPT_KEY, jami::ACTIVE_CODEC_KEY, activeCallLimit, activeCodecs, alias, jami::ALIAS_KEY, jami::ALL_MODERATORS_ENABLED_KEY, allModeratorsEnabled, autoAnswerEnabled, customUserAgent, jami::DEFAULT_MODERATORS_KEY, defaultModerators, jami::DENY_SECOND_CALL_KEY, denySecondCallEnabled, deviceKey, jami::DISPLAY_NAME_KEY, displayName, jami::emitSignal(), enabled, hostname, jami::HOSTNAME_KEY, isRendezVous, jami::LOCAL_MODERATORS_ENABLED_KEY, localModeratorsEnabled, mailbox, jami::MAILBOX_KEY, notificationTopic, platform, jami::PROXY_PUSH_PLATFORM_KEY, jami::PROXY_PUSH_TOKEN_KEY, jami::PROXY_PUSH_TOPIC_KEY, jami::RINGTONE_ENABLED_KEY, jami::RINGTONE_PATH_KEY, ringtoneEnabled, ringtonePath, sendComposing, sendReadReceipt, SERIALIZE_CONFIG, type, jami::TYPE_KEY, jami::UI_CUSTOMIZATION, uiCustomization, jami::UPNP_ENABLED_KEY, upnpEnabled, jami::USER_AGENT_KEY, username, jami::USERNAME_KEY, jami::VIDEO_ENABLED_KEY, and videoEnabled.

Referenced by jami::SipAccountBaseConfig::serializeDiff().

Here is the call graph for this function:

◆ toMap()

std::map< std::string, std::string > jami::AccountConfig::toMap ( ) const

virtual

Reimplemented in jami::JamiAccountConfig, jami::SipAccountConfig, and jami::SipAccountBaseConfig.

Definition at line 130 of file account_config.cpp.

Referenced by jami::Account::getAccountDetails(), and jami::SipAccountBaseConfig::toMap().

Here is the call graph for this function:

◆ unserialize()

void jami::AccountConfig::unserialize ( const YAML::Node & node )

virtual

Implements jami::Serializable.

Reimplemented in jami::JamiAccountConfig, jami::SipAccountConfig, and jami::SipAccountBaseConfig.

Definition at line 91 of file account_config.cpp.

References jami::ACCOUNT_ACTIVE_CALL_LIMIT_KEY, jami::ACCOUNT_AUTOANSWER_KEY, jami::ACCOUNT_COMPOSING_KEY, jami::ACCOUNT_ENABLE_KEY, jami::ACCOUNT_ISRENDEZVOUS_KEY, jami::ACCOUNT_READRECEIPT_KEY, jami::ACTIVE_CODEC_KEY, activeCallLimit, activeCodecs, alias, jami::ALIAS_KEY, jami::ALL_MODERATORS_ENABLED_KEY, allModeratorsEnabled, autoAnswerEnabled, customUserAgent, jami::DEFAULT_MODERATORS_KEY, defaultModerators, jami::DENY_SECOND_CALL_KEY, denySecondCallEnabled, deviceKey, jami::DISPLAY_NAME_KEY, displayName, jami::emitSignal(), enabled, hostname, jami::HOSTNAME_KEY, isRendezVous, jami::LOCAL_MODERATORS_ENABLED_KEY, localModeratorsEnabled, mailbox, jami::MAILBOX_KEY, notificationTopic, platform, jami::PROXY_PUSH_PLATFORM_KEY, jami::PROXY_PUSH_TOKEN_KEY, jami::PROXY_PUSH_TOPIC_KEY, jami::RINGTONE_ENABLED_KEY, jami::RINGTONE_PATH_KEY, ringtoneEnabled, ringtonePath, sendComposing, sendReadReceipt, jami::split_string_to_unsigned(), jami::string_split_set(), jami::UI_CUSTOMIZATION, uiCustomization, jami::UPNP_ENABLED_KEY, upnpEnabled, jami::USER_AGENT_KEY, jami::VIDEO_ENABLED_KEY, and videoEnabled.

Referenced by jami::SipAccountBaseConfig::unserialize().

Here is the call graph for this function:

Member Data Documentation

◆ activeCallLimit

int jami::AccountConfig::activeCallLimit {-1}

The number of concurrent calls for the account -1: Unlimited 0: Do not disturb 1: Single call +: Multi line.

Definition at line 91 of file account_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ activeCodecs

std::vector<unsigned> jami::AccountConfig::activeCodecs {}

Definition at line 93 of file account_config.h.

Referenced by serializeDiff(), and unserialize().

◆ alias

std::string jami::AccountConfig::alias {}

A user-defined name for this account.

Definition at line 59 of file account_config.h.

Referenced by fromMap(), jami::Account::getAlias(), serializeDiff(), toMap(), and unserialize().

◆ allModeratorsEnabled

bool jami::AccountConfig::allModeratorsEnabled {true}

Definition at line 132 of file account_config.h.

Referenced by fromMap(), jami::Account::isAllModerators(), serializeDiff(), jami::Manager::setAllModerators(), toMap(), and unserialize().

◆ autoAnswerEnabled

bool jami::AccountConfig::autoAnswerEnabled {false}

If true, automatically answer calls to this account.

Definition at line 70 of file account_config.h.

Referenced by fromMap(), jami::Account::isAutoAnswerEnabled(), serializeDiff(), toMap(), and unserialize().

◆ customUserAgent

std::string jami::AccountConfig::customUserAgent {}

User-agent used for registration.

Definition at line 118 of file account_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ defaultModerators

std::set<std::string> jami::AccountConfig::defaultModerators {}

Definition at line 130 of file account_config.h.

Referenced by fromMap(), jami::Account::getDefaultModerators(), serializeDiff(), toMap(), and unserialize().

◆ denySecondCallEnabled

bool jami::AccountConfig::denySecondCallEnabled {false}

If true, automatically deny new calls when already in one call to this account.

Definition at line 73 of file account_config.h.

Referenced by fromMap(), jami::Account::isDenySecondCallEnabled(), serializeDiff(), toMap(), and unserialize().

◆ deviceKey

std::string jami::AccountConfig::deviceKey {}

Device push notification token.

Definition at line 137 of file account_config.h.

Referenced by fromMap(), jami::JamiAccount::isMobile(), serializeDiff(), and unserialize().

◆ displayName

std::string jami::AccountConfig::displayName {}

Display name when calling.

Definition at line 113 of file account_config.h.

Referenced by fromMap(), jami::Account::getDisplayName(), serializeDiff(), toMap(), unserialize(), and jami::JamiAccount::updateProfile().

◆ enabled

bool jami::AccountConfig::enabled {true}

True if the account is enabled.

Definition at line 67 of file account_config.h.

Referenced by fromMap(), jami::Account::isEnabled(), jami::Account::isUsable(), serializeDiff(), toMap(), and unserialize().

◆ hostname

std::string jami::AccountConfig::hostname {}

SIP hostname (SIP account) or DHT bootstrap nodes (Jami account)

Definition at line 64 of file account_config.h.

Referenced by fromMap(), jami::JamiAccountConfig::fromMap(), jami::Account::getHostname(), serializeDiff(), toMap(), and unserialize().

◆ id

const std::string jami::AccountConfig::id

Account id.

Definition at line 51 of file account_config.h.

Referenced by jami::SipAccountConfig::serialize().

◆ isRendezVous

bool jami::AccountConfig::isRendezVous {false}

If true mix calls into a conference.

Definition at line 82 of file account_config.h.

Referenced by fromMap(), jami::Account::isRendezVous(), serializeDiff(), toMap(), and unserialize().

◆ localModeratorsEnabled

bool jami::AccountConfig::localModeratorsEnabled {true}

Definition at line 131 of file account_config.h.

Referenced by jami::Manager::enableLocalModerators(), fromMap(), jami::Account::isLocalModeratorsEnabled(), serializeDiff(), toMap(), and unserialize().

◆ mailbox

std::string jami::AccountConfig::mailbox {}

Account mail box.

Definition at line 123 of file account_config.h.

Referenced by fromMap(), jami::Account::getMailBox(), serializeDiff(), toMap(), and unserialize().

◆ notificationTopic

std::string jami::AccountConfig::notificationTopic {}

Push notification topic.

Definition at line 146 of file account_config.h.

Referenced by fromMap(), serializeDiff(), and unserialize().

◆ path

const std::filesystem::path jami::AccountConfig::path

Path where the configuration file is stored.

Part of the context but not stored in the configuration Used to compute relative paths for configuraton fields

Definition at line 56 of file account_config.h.

Referenced by jami::JamiAccountConfig::fromMap(), jami::SipAccountConfig::fromMap(), jami::JamiAccountConfig::toMap(), and jami::JamiAccountConfig::unserialize().

◆ platform

std::string jami::AccountConfig::platform {}

Device push notification platform.

Definition at line 141 of file account_config.h.

Referenced by fromMap(), serializeDiff(), and unserialize().

◆ ringtoneEnabled

bool jami::AccountConfig::ringtoneEnabled {true}

Play ringtone when receiving a call.

Definition at line 98 of file account_config.h.

Referenced by fromMap(), jami::Account::getRingtoneEnabled(), serializeDiff(), toMap(), and unserialize().

◆ ringtonePath

std::string jami::AccountConfig::ringtonePath {DEFAULT_RINGTONE_PATH}

Ringtone file used for this account.

Definition at line 103 of file account_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ sendComposing

bool jami::AccountConfig::sendComposing {true}

If true, send composing status (and emit to the client)

Definition at line 79 of file account_config.h.

Referenced by fromMap(), jami::Account::isComposingEnabled(), serializeDiff(), toMap(), and unserialize().

◆ sendReadReceipt

bool jami::AccountConfig::sendReadReceipt {true}

If true, send displayed status (and emit to the client)

Definition at line 76 of file account_config.h.

Referenced by fromMap(), jami::Account::isReadReceiptEnabled(), serializeDiff(), toMap(), and unserialize().

◆ type

const std::string jami::AccountConfig::type

Account type.

Definition at line 48 of file account_config.h.

Referenced by serializeDiff(), and toMap().

◆ uiCustomization

std::string jami::AccountConfig::uiCustomization {}

information about the customization of ui

Definition at line 151 of file account_config.h.

Referenced by fromMap(), jami::JamiAccountConfig::fromMap(), serializeDiff(), toMap(), and unserialize().

◆ upnpEnabled

bool jami::AccountConfig::upnpEnabled {true}

UPnP IGD controller and the mutex to access it.

Definition at line 128 of file account_config.h.

Referenced by fromMap(), serializeDiff(), toMap(), and unserialize().

◆ username

std::string jami::AccountConfig::username {}

Definition at line 61 of file account_config.h.

Referenced by jami::SipAccountConfig::Credentials::computePasswordHash(), jami::SipAccountConfig::fromMap(), jami::Account::getUsername(), jami::SipAccountConfig::serialize(), serializeDiff(), toMap(), jami::SipAccountConfig::Credentials::toMap(), jami::SipAccountConfig::toMap(), and jami::SipAccountConfig::unserialize().

◆ videoEnabled

bool jami::AccountConfig::videoEnabled {true}

Allows user to temporarily disable video calling.

Definition at line 108 of file account_config.h.

Referenced by jami::Account::enableVideo(), fromMap(), jami::Account::isVideoEnabled(), serializeDiff(), toMap(), and unserialize().

The documentation for this struct was generated from the following files:

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AccountConfig()

Member Function Documentation

◆ fromMap()

◆ serialize()

◆ serializeDiff()

◆ toMap()

◆ unserialize()

Member Data Documentation

◆ activeCallLimit

◆ activeCodecs

◆ alias

◆ allModeratorsEnabled

◆ autoAnswerEnabled

◆ customUserAgent

◆ defaultModerators

◆ denySecondCallEnabled

◆ deviceKey

◆ displayName

◆ enabled

◆ hostname

◆ id

◆ isRendezVous

◆ localModeratorsEnabled

◆ mailbox

◆ notificationTopic

◆ path

◆ platform

◆ ringtoneEnabled

◆ ringtonePath

◆ sendComposing

◆ sendReadReceipt

◆ type

◆ uiCustomization

◆ upnpEnabled

◆ username

◆ videoEnabled