Compare commits

...

2 Commits

10 changed files with 40 additions and 41 deletions

View File

@@ -50,7 +50,7 @@ func (cli *Cli) GetClusterAlerts() (map[string]string, error) {
// GetDomainAlerts retrieves the domain-wide Alerts.
//
// Parameters:
// - domain: an optional name of an existing Domain.
// - domain: an optional Domain name.
// If an empty string is provided, the command typically targets the
// current domain context.
//
@@ -118,7 +118,7 @@ func (cli *Cli) PostClusterAlert(alert string) error {
// PostDomainAlert posts a domain-wide Alert message.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - alert: the text of the alert to be posted.
//
// This method executes the POSTDOMAINALERT CLI command.
@@ -196,7 +196,7 @@ func (cli *Cli) RemoveClusterAlert(timeStamp string) error {
// RemoveDomainAlert removes a specific domain-wide alert message.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - timeStamp: the exact timestamp string of the domain alert
// to be removed, as retrieved by GetDomainAlerts.
//
@@ -270,7 +270,7 @@ func (cli *Cli) SetClusterAlerts(alerts map[string]any) error {
// SetDomainAlerts replaces the entire Domain alert dictionary.
//
// Parameters:
// - domain: an optional name of an existing Domain.
// - domain: an optional Domain name.
// If an empty string is provided, the command targets the current domain context.
// - alerts: a dictionary used to replace the current Domain alert dictionary.
//

View File

@@ -121,7 +121,7 @@ func (cli *Cli) GetAccountTemplate(domain string) (map[string]any, error) {
// GetDomainAliases retrieves the list of Domain Aliases.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
//
// This method executes the GETDOMAINALIASES CLI command.
//
@@ -138,7 +138,7 @@ func (cli *Cli) GetDomainAliases(domain string) ([]string, error) {
// GetDomainEffectiveSettings retrieves both explicitly set and default Domain settings.
//
// Parameters:
// - domain: an optional name of an existing Domain. If empty, uses the current context.
// - domain: an optional Domain name.
//
// This method executes the GETDOMAINEFFECTIVESETTINGS CLI command.
//
@@ -152,7 +152,7 @@ func (cli *Cli) GetDomainEffectiveSettings(domain string) (map[string]any, error
// GetDomainLocation retrieves the Domain file directory path relative to the Server base.
//
// Parameters:
// - domain: the Domain name. If empty, applies to the administrator Domain.
// - domain: an optional Domain name. If empty, applies to the administrator Domain.
//
// This method executes the GETDOMAINLOCATION CLI command.
//
@@ -166,7 +166,7 @@ func (cli *Cli) GetDomainLocation(domain string) (string, error) {
// GetDomainMailRules retrieves the list of Domain Queue Mail Rules.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
//
// This method executes the GETDOMAINMAILRULES CLI command.
//
@@ -183,7 +183,7 @@ func (cli *Cli) GetDomainMailRules(domain string) ([]MailRule, error) {
// GetDomainSettings retrieves explicitly set (non-default) Domain settings.
//
// Parameters:
// - domain: an optional name of an existing Domain. If empty, uses the current context.
// - domain: an optional Domain name.
//
// This method executes the GETDOMAINSETTINGS CLI command.
//
@@ -197,7 +197,7 @@ func (cli *Cli) GetDomainSettings(domain string) (map[string]any, error) {
// GetDomainSignalRules retrieves the list of Domain Signal Rules.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
//
// This method executes the GETDOMAINSIGNALRULES CLI command.
//
@@ -227,7 +227,7 @@ func (cli *Cli) InsertDirectoryRecords(domain string) error {
// IsDomainExists checks if a domain exists by attempting to retrieve its location.
//
// Parameters:
// - domain: the name of the domain to check.
// - domain: the Domain name.
//
// Returns:
// - bool: true if the domain exists.
@@ -405,7 +405,7 @@ func (cli *Cli) ListDomainTelnums(domain, filter string, limit int) (map[string]
// ResumeDomain resumes a suspended Domain so Accounts can be opened.
//
// Parameters:
// - domain: the name of the Domain to be resumed.
// - domain: the Domain name.
//
// This method executes the RESUMEDOMAIN CLI command.
//
@@ -421,7 +421,7 @@ func (cli *Cli) ResumeDomain(domain string) error {
// SetAccountDefaultPrefs replaces the Default Account Preferences for the Domain.
//
// Parameters:
// - domain: the Domain name. If empty, applies to the authenticated user Domain.
// - domain: an optional Domain name. If empty, applies to the authenticated user Domain.
// - settings: a dictionary used to replace the Default Account Preferences.
//
// This method executes the SETACCOUNTDEFAULTPREFS CLI command.
@@ -472,7 +472,7 @@ func (cli *Cli) SetAccountTemplate(domain string, settings map[string]any) error
// SetDomainAliases sets the Domain aliases, replacing all existing ones.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - aliases: an array of Domain alias name strings.
//
// This method executes the SETDOMAINALIASES CLI command.
@@ -489,7 +489,7 @@ func (cli *Cli) SetDomainAliases(domain string, aliases []string) error {
// SetDomainMailRules sets the Domain Queue Mail Rules, replacing all old ones.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - rules: an array containing the new Domain Queue Rules.
//
// This method executes the SETDOMAINMAILRULES CLI command.
@@ -506,7 +506,7 @@ func (cli *Cli) SetDomainMailRules(domain string, rules []MailRule) error {
// SetDomainSettings replaces the entire Domain settings dictionary.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - settings: a dictionary used to replace the Domain settings.
//
// This method executes the SETDOMAINSETTINGS CLI command.
@@ -523,7 +523,7 @@ func (cli *Cli) SetDomainSettings(domain string, settings map[string]any) error
// SetDomainSignalRules sets the Domain Signal Rules, replacing all old ones.
//
// Parameters:
// - domain: the name of an existing Domain.
// - domain: the Domain name.
// - rules: an array containing the new Domain Signal Rules.
//
// This method executes the SETDOMAINSIGNALRULES CLI command.
@@ -540,7 +540,7 @@ func (cli *Cli) SetDomainSignalRules(domain string, rules []SignalRule) error {
// SuspendDomain suspends a Domain, closing active accounts and preventing new ones.
//
// Parameters:
// - domain: the name of the Domain to be suspended.
// - domain: the Domain name.
//
// This method executes the SUSPENDDOMAIN CLI command.
//
@@ -607,7 +607,7 @@ func (cli *Cli) UpdateAccountTemplate(domain string, settings map[string]any) er
// UpdateDomainSettings updates specific Domain settings without modifying others.
//
// Parameters:
// - domain: an optional name of an existing Domain. If empty, uses the current context.
// - domain: an optional Domain name.
// - settings: a dictionary containing the settings to update.
//
// This method executes the UPDATEDOMAINSETTINGS CLI command.

View File

@@ -26,7 +26,7 @@ import (
// This operation is allowed only when the Directory-based Domains are enabled.
//
// Parameters:
// - domain: the Domain name to create.
// - domain: the Domain name.
// - settings: an optional dictionary specifying the Domain settings.
//
// This method executes the CREATEDIRECTORYDOMAIN CLI command.
@@ -49,7 +49,7 @@ func (cli *Cli) CreateDirectoryDomain(domain string, settings map[string]any) er
// CreateDomain creates a new secondary Domain.
//
// Parameters:
// - domain: the Domain name to create.
// - domain: the Domain name.
// - shared: if true, creates a Cluster-wide Domain (Dynamic Cluster only).
// - storage: an optional "storage mount point" directory name (without .mnt suffix).
// - settings: an optional dictionary specifying the initial Domain settings.
@@ -103,7 +103,7 @@ func (cli *Cli) CreateDomainStorage(storage string, shared bool) error {
// DeleteDomain removes an existing Domain.
//
// Parameters:
// - domain: the name of the Domain to be removed.
// - domain: the Domain name.
// - force: if true, removes the Domain even if it contains accounts or other objects.
//
// This method executes the DELETEDOMAIN CLI command.

View File

@@ -87,7 +87,7 @@ func (cli *Cli) GetForwarder(forwarder string) (string, error) {
// ListForwarders retrieves the list of all Forwarders in the Domain.
//
// Parameters:
// - domain: an optional Domain name. If not specified, the command applies to the administrator Domain.
// - domain: an optional Domain name. If empty, applies to the administrator Domain.
//
// This method executes the LISTFORWARDERS CLI command.
//

View File

@@ -128,7 +128,7 @@ func (cli *Cli) IsGroupExists(group string) (bool, error) {
// ListGroups retrieves the list of all Groups in the Domain.
//
// Parameters:
// - domain: an optional Domain name. If the Domain name is not specified, the command applies to the administrator Domain.
// - domain: an optional Domain name. If empty, applies to the administrator Domain.
//
// This method executes the LISTGROUPS CLI command.
//

View File

@@ -195,7 +195,7 @@ func (cli *Cli) ListClusterPBXFiles(language string) (map[string]*FileInfo, erro
// ListDomainPBXFiles lists files in the Domain Real-Time Application Environment.
//
// Parameters:
// - domain: an optional Domain name. If not specified, the administrator Domain is used.
// - domain: an optional Domain name. If empty, applies to the administrator Domain.
// - language: an optional national subset name.
//
// This method executes the LISTDOMAINPBXFILES CLI command.

View File

@@ -49,7 +49,7 @@ func (cli *Cli) GetAccountStat(account string, key string) (any, error) {
// GetDomainStat retrieves statistics data about the specified Domain.
//
// Parameters:
// - domain: the name of an existing Domain. The asterisk (*) symbol can
// - domain: the Domain name. The asterisk (*) symbol can
// be used to specify the Domain of the current authenticated Account.
// - key: an optional the name of the statistical entry to retrieve.
//
@@ -100,7 +100,7 @@ func (cli *Cli) ResetAccountStat(account string, key string) error {
// ResetDomainStat resets statistics data about the specified Domain.
//
// Parameters:
// - domain: the name of an existing Domain. The asterisk (*) symbol can
// - domain: the Domain name. The asterisk (*) symbol can
// be used to specify the Domain of the current authenticated Account.
// - key: an optional the name of the statistical entry to reset.
// If the key is not specified, all Domain statistical entries are reset.

View File

@@ -97,8 +97,7 @@ func (cli *Cli) ListAccountNamedTasks(account string) (map[string]any, error) {
// ListDomainNamedTasks retrieves the list of all Named Tasks in the Domain.
//
// Parameters:
// - domain: an optional Domain name. If the Domain name is not specified,
// the command applies to the administrator Domain.
// - domain: an optional Domain name. If empty, applies to the administrator Domain.
//
// This method executes the LISTDOMAINNAMEDTASKS CLI command.
//

View File

@@ -198,7 +198,7 @@ func (cli *Cli) FindAccountSession(account, addr, origAddr, protocol, transport,
//
// Parameters:
// - sessionID: the Session ID.
// - domain: an optional the name of Domain the session Account belongs to.
// - domain: an optional Domain name the session Account belongs to.
//
// This method executes the GETSESSION CLI command.
//
@@ -222,7 +222,7 @@ func (cli *Cli) GetSession(sessionID, domain string) (map[string]any, error) {
//
// Parameters:
// - sessionID: the Session ID.
// - domain: an optional the name of Domain the session Account belongs to.
// - domain: an optional Domain name the session Account belongs to.
//
// This method executes the KILLSESSION CLI command.
//
@@ -309,7 +309,7 @@ func (cli *Cli) ListLiteSessions(addr, origAddr string) ([]string, error) {
//
// Parameters:
// - sessionID: the Session ID.
// - domain: an optional the name of Domain the session Account belongs to.
// - domain: an optional Domain name the session Account belongs to.
// - file: the name for the File Storage file.
// - uploadID: identifies a file in the "uploaded file set".
// - offset: an optional the file position. Can be a positive number,
@@ -351,7 +351,7 @@ func (cli *Cli) StoreSessionFile(sessionID, domain, file, uploadID string, offse
//
// Parameters:
// - sessionID: the Session ID.
// - domain: an optional the name of Domain the session Account belongs to.
// - domain: an optional Domain name the session Account belongs to.
// - data: the dictionary that lists new values for the attributes
// to be updated.
//

View File

@@ -42,7 +42,7 @@ func (cli *Cli) CreateClusterSkin(skin string) error {
// CreateDomainSkin creates a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of the new Skin. To create the unnamed Domain
// Skin, specify an empty string.
//
@@ -111,7 +111,7 @@ func (cli *Cli) DeleteClusterSkinFile(skin, file string) error {
// DeleteDomainSkin deletes a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of the Skin to be deleted. To delete the
// unnamed Domain Skin, specify an empty string.
//
@@ -131,7 +131,7 @@ func (cli *Cli) DeleteDomainSkin(domain, skin string) error {
// DeleteDomainSkinFile removes a file from a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of an existing Domain Skin.
// - file: the Skin file name to be deleted.
//
@@ -217,7 +217,7 @@ func (cli *Cli) ListClusterSkins() ([]string, error) {
// ListDomainSkinFiles lists files in a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of an existing Domain Skin.
//
// This method executes the LISTDOMAINSKINFILES CLI command.
@@ -245,7 +245,7 @@ func (cli *Cli) ListDomainSkinFiles(domain, skin string) (map[string]*FileInfo,
// ListDomainSkins lists custom Domain Skins.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
//
// This method executes the LISTDOMAINSKINS CLI command.
//
@@ -325,7 +325,7 @@ func (cli *Cli) ReadClusterSkinFile(skin, file string) ([]byte, time.Time, error
// ReadDomainSkinFile reads a file from a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of an existing Domain Skin.
// - file: the name of an existing file in the Skin.
//
@@ -459,7 +459,7 @@ func (cli *Cli) RenameClusterSkin(oldSkin, newSkin string) error {
// RenameDomainSkin renames a custom named Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - oldSkin: the name of an existing named Skin.
// - newSkin: the new name for the Skin.
//
@@ -518,7 +518,7 @@ func (cli *Cli) StoreClusterSkinFile(skin, file string, data []byte) error {
// StoreDomainSkinFile stores a file into a custom Domain Skin.
//
// Parameters:
// - domain: an optional the Domain name.
// - domain: an optional Domain name.
// - skin: the name of an existing Domain Skin.
// - file: the Skin file name.
// - data: the file content.