Class Aurora\Modules\RocketChatWebclient\Module

`extends`	`AbstractModule`

Aurora\System\Module\AbstractModule
- Aurora\Modules\RocketChatWebclient\Module

Located at modules/RocketChatWebclient/Module.php

Methods


					
	public
					static

getInstance(): Module

Overrides

Aurora\System\Module\AbstractModule::getInstance()


					
	public
					static

Decorator(): Module

Overrides

Aurora\System\Module\AbstractModule::Decorator()


					
	public

getModuleSettings(): Settings

Overrides

Aurora\System\Module\AbstractModule::getModuleSettings()


					
	public

init()

Implements

Aurora\System\Module\AbstractModule::init()


					
	public

GetSettings(int|null $TenantId = null): array

Obtains list of module settings for authenticated user.

Parameters

$TenantId

Tenant ID

Overrides

Aurora\System\Module\AbstractModule::GetSettings()


					
	public

UpdateSettings(int $TenantId, string $ChatUrl, string $AdminUsername, string $AdminPassword = null): boolean

Updates settings of the Chat Module.


					
	public

GetRocketChatSettings(int|null $TenantId = null): array

This method returns the set of RocketChat settings that should havep artucular values.


					
	public

TestConnection(int|null $TenantId, string $ChatUrl, string $AdminUsername, string $AdminPassword = null): boolean

Checks connection to RocketChat with provided credentials. Uses saved password if password argument is ommitted.


					
	public

ApplyRocketChatRequiredChanges(int|null $TenantId = null): bool

Applies some settings to RocketChat to achive better integration with Aurora


					
	public

ApplyRocketChatTextChanges(int|null $TenantId = null): bool

Applies some text changes to RocketChat like user's home page.


					
	public

ApplyRocketChatCssChanges(int|null $TenantId = null): bool

Applies css theme tweeks to match RocketChat custome theme to Aurora's one


					
	public

EntryChatDirect()

This method handles direct chat entry point which can be used to start personal chat with a contact.


					
	public

EntryChat()

This method handles direct chat entry point which is used to open RocketChat UI in a separate window.


					
	public

InitChat()


					
	public

GetLoginForCurrentUser()

Returns RocketChat user's login for currently logged in user.


					
	public

GetLoginForEmail(string $Email): string|false

This method allows to get RocketChat login for a provided email address. If RocketChat account is missing it will be…

This method allows to get RocketChat login for a provided email address. If RocketChat account is missing it will be created


					
	public

onBeforeDeleteUser(&$aArgs, &$mResult)


					
	public

onAfterLogout($aArgs, &$mResult)

Methods inherited from Aurora\System\Module\AbstractModule
__construct(), createInstance(), RequireModule(), GetRequireModules(), isPermanent(), isValid(), initialize(), getNamespace(), loadModuleSettings(), saveModuleConfig(), getConfig(), setConfig(), denyMethodsCallByWebApi(), denyMethodCallByWebApi(), subscribeEvent(), broadcastEvent(), skipEvent(), removeEventFromSkiped(), includeTemplate(), extendObject(), getExtendedObject(), issetObject(), SetPath(), GetHash(), GetName(), getModuleName(), GetPath(), GetVersion(), GetFullName(), AddEntry(), AddEntries(), HasEntry(), RemoveEntry(), RemoveEntries(), GetEntryCallback(), DefaultResponse(), TrueResponse(), FalseResponse(), ExceptionResponse(), CallMethod(), i18N(), GetErrors(), GetErrorMessageByCode(), GetAdditionalEntityFieldsToEdit()

Methods inherited from Aurora\System\Module\AbstractModule

__construct(), createInstance(), RequireModule(), GetRequireModules(), isPermanent(), isValid(), initialize(), getNamespace(), loadModuleSettings(), saveModuleConfig(), getConfig(), setConfig(), denyMethodsCallByWebApi(), denyMethodCallByWebApi(), subscribeEvent(), broadcastEvent(), skipEvent(), removeEventFromSkiped(), includeTemplate(), extendObject(), getExtendedObject(), issetObject(), SetPath(), GetHash(), GetName(), getModuleName(), GetPath(), GetVersion(), GetFullName(), AddEntry(), AddEntries(), HasEntry(), RemoveEntry(), RemoveEntries(), GetEntryCallback(), DefaultResponse(), TrueResponse(), FalseResponse(), ExceptionResponse(), CallMethod(), i18N(), GetErrors(), GetErrorMessageByCode(), GetAdditionalEntityFieldsToEdit()

Properties
`public`		`$oRocketChatSettingsManager = null`	#
`public`	`Settings`	`$oModuleSettings`	#

Properties inherited from Aurora\System\Module\AbstractModule
`$oHttp, $Delimiter, $aErrors, $aAdditionalEntityFieldsToEdit`

Namespaces

Classes

Class Aurora\Modules\RocketChatWebclient\Module

Overrides

Overrides

Overrides

Implements

Parameters

Overrides