Table of Contents

Class appManagement

Namespace
PHCLibrary
Assembly
PHCLibrary.dll
public class appManagement
Inheritance
appManagement

Fields

WebContextRole 

public const string WebContextRole = "context-role"

Field Value

string

WebHeaderAuth 

public const string WebHeaderAuth = "Engine-Auth"

Field Value

string

WebLanguage 

public const string WebLanguage = "lang"

Field Value

string

WebRequestID 

public const string WebRequestID = "Request-ID"

Field Value

string

WebRequestStart 

public const string WebRequestStart = "Request-Start"

Field Value

string

WebSessionID 

public const string WebSessionID = "Session-ID"

Field Value

string

WebTimezone 

public const string WebTimezone = "timezone"

Field Value

string

_adicionalSchedules 

public static int _adicionalSchedules

Field Value

int

_userManagement 

protected static UserManagement _userManagement

Field Value

UserManagement

Properties

AdicionalRequests 

public static int AdicionalRequests { get; }

Property Value

int

AdicionalUsers 

public static int AdicionalUsers { get; }

Property Value

int

AppAddons

Contem os add-ons instalados na aplicação

public static List<AddonInstallationVO> AppAddons { get; }

Property Value

List<AddonInstallationVO>

ApplicationID 

public static string ApplicationID { get; }

Property Value

string

DigitalSignCredits 

public static Dictionary<string, int> DigitalSignCredits { get; }

Property Value

Dictionary<string, int>

Empresa 

public static string Empresa { get; }

Property Value

string

Gama 

public static Gamas Gama { get; }

Property Value

Gamas

RequestID 

public static string RequestID { get; }

Property Value

string

SaleLanguage 

public static languages SaleLanguage { get; }

Property Value

languages

ServerOffset 

public static int ServerOffset { get; }

Property Value

int

SessionID 

public static string SessionID { get; }

Property Value

string

ThreadID 

public static string ThreadID { get; set; }

Property Value

string

UserInfo

Não usar esta propriedade dentro de expressões de LINQ

public static UserLogin UserInfo { get; }

Property Value

UserLogin

UserLanguage 

public static languages UserLanguage { get; set; }

Property Value

languages

UserTimezoneOffset 

public static int UserTimezoneOffset { get; set; }

Property Value

int

WSContext 

public static IWSContext WSContext { get; set; }

Property Value

IWSContext

adicionalSchedules 

public static int adicionalSchedules { get; }

Property Value

int

aplicationName 

public static string aplicationName { get; }

Property Value

string

authMethod 

public static AuthorizationMethods authMethod { get; set; }

Property Value

AuthorizationMethods

authStatus 

public static AuthorizationStatus authStatus { get; set; }

Property Value

AuthorizationStatus

bradingName 

public static string bradingName { get; }

Property Value

string

certificado 

public static string certificado { get; }

Property Value

string

certificadoID 

public static string certificadoID { get; }

Property Value

string

endDate 

public static DateTime endDate { get; }

Property Value

DateTime

firstTimeEmail 

public static string firstTimeEmail { get; }

Property Value

string

firstTimeUserCode 

public static string firstTimeUserCode { get; }

Property Value

string

hasFrameworkAccess 

public static bool hasFrameworkAccess { get; }

Property Value

bool

hasSizeFreeProduct 

public static bool hasSizeFreeProduct { get; }

Property Value

bool

internalVersion 

public static BackendVersion internalVersion { get; }

Property Value

BackendVersion

invalidLicenceCaused 

public static string invalidLicenceCaused { get; }

Property Value

string

invalidLicenceCausedData 

public static string[] invalidLicenceCausedData { get; }

Property Value

string[]

isFirstTimeUser 

public static bool isFirstTimeUser { get; }

Property Value

bool

isKitParceiro 

public static bool isKitParceiro { get; }

Property Value

bool

isKitParceiroApp 

public static bool isKitParceiroApp { get; }

Property Value

bool

isKitParceiroDev 

public static bool isKitParceiroDev { get; }

Property Value

bool

isTrial 

public static bool isTrial { get; set; }

Property Value

bool

isValidLicence 

public static bool isValidLicence { get; }

Property Value

bool

listEngines 

public static List<EngineIDLicenceVO> listEngines { get; }

Property Value

List<EngineIDLicenceVO>

manufactor 

public static string manufactor { get; }

Property Value

string

versaochave 

public static string versaochave { get; }

Property Value

string

Methods

AddAddon(AddonInstallationVO) 

public static void AddAddon(AddonInstallationVO addon)

Parameters

Nome Tipo Descrição
addon AddonInstallationVO

AddAddons(List<object>) 

public static void AddAddons(List<object> listOfAddons)

Parameters

Nome Tipo Descrição
listOfAddons List<object>

AddDigitalSignCredits(string, int)

productinfo contains : 'DIGITAL_SIGN_PACK'#'EmpresaXXXX'

public static void AddDigitalSignCredits(string productInfo, int credits)

Parameters

Nome Tipo Descrição
productInfo string
credits int

AddProduct(ProductLicenceVO)

License products by instalation/company

public static void AddProduct(ProductLicenceVO productItem)

Parameters

Nome Tipo Descrição
productItem ProductLicenceVO

Examples

ProductId - ProductName - CompanyName - Remarks

35 Agenda Available on all BDs 20 POS BDname01 20 POS BDname02 20 POS Invalid config, there can be no such definition 37 Documents BDname01 Only BDname01 database

AddProduct(string) 

public static void AddProduct(string productCredentials)

Parameters

Nome Tipo Descrição
productCredentials string

AddProductByAddon(int, string) 

public static void AddProductByAddon(int productId, string productName)

Parameters

Nome Tipo Descrição
productId int
productName string

AddProductByEdition() 

public static void AddProductByEdition()

AppProducts()

As this function does not receive the name of the database, it is assumed that, in this context, we want to use the current login database, if there is no login, then we return all licensed products.

public static IEnumerable<ProductLicenceVO> AppProducts()

Returns

IEnumerable<ProductLicenceVO>

AppProducts(string)

This is a function that forces you to send the name of the database, so if the name is empty, we assume that we must return all licensed products

public static IEnumerable<ProductLicenceVO> AppProducts(string companyName)

Parameters

Nome Tipo Descrição
companyName string

Returns

IEnumerable<ProductLicenceVO>

ContextRole() 

public static ContextRole ContextRole()

Returns

ContextRole

DelProductByAddon(int) 

public static void DelProductByAddon(int productid)

Parameters

Nome Tipo Descrição
productid int

DisableUserLogin(IEnumerable<UserLogin>, string, string[]) 

public static void DisableUserLogin(IEnumerable<UserLogin> userLogins, string notifyMsg, string[] msgParas = null)

Parameters

Nome Tipo Descrição
userLogins IEnumerable<UserLogin>
notifyMsg string
msgParas string[]

ExistAnyConcurrentConsumptionProduct(List<int>) 

public static bool ExistAnyConcurrentConsumptionProduct(List<int> products)

Parameters

Nome Tipo Descrição
products List<int>

Returns

bool

ExistAnyLimitedConsumptionProduct(List<int>) 

public static bool ExistAnyLimitedConsumptionProduct(List<int> products)

Parameters

Nome Tipo Descrição
products List<int>

Returns

bool

ExistContextRoleHeader() 

public static bool ExistContextRoleHeader()

Returns

bool

ExistUserLogin() 

public static bool ExistUserLogin()

Returns

bool

GetBaseRequests() 

public static int GetBaseRequests()

Returns

int

GetLoginAvailable() 

public static int GetLoginAvailable()

Returns

int

GetLoginCount() 

public static int GetLoginCount()

Returns

int

GetMaxPayrollEmployees() 

public static int GetMaxPayrollEmployees()

Returns

int

GetProductLicenseLimit(int) 

public static int GetProductLicenseLimit(int productId)

Parameters

Nome Tipo Descrição
productId int

Returns

int

GetRequestsAvailable() 

public static int GetRequestsAvailable()

Returns

int

GetUserLogins() 

public static List<UserLogin> GetUserLogins()

Returns

List<UserLogin>

GetUserManagement(string) 

public static UserManagement GetUserManagement(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

Returns

UserManagement

IsAnyProductLicence(List<Products>) 

public static bool IsAnyProductLicence(List<Products> productIds)

Parameters

Nome Tipo Descrição
productIds List<Products>

Returns

bool

IsAnyProductLicence(List<Products>, string)

Use this form of validation only in very specific cases, always opt for the signature without indicating the name of the database

public static bool IsAnyProductLicence(List<Products> productIds, string companyName)

Parameters

Nome Tipo Descrição
productIds List<Products>
companyName string

Returns

bool

IsAnyProductLicence(List<int>) 

public static bool IsAnyProductLicence(List<int> productIds)

Parameters

Nome Tipo Descrição
productIds List<int>

Returns

bool

IsAnyProductLicence(List<int>, string)

Use this form of validation only in very specific cases, always opt for the signature without indicating the name of the database

public static bool IsAnyProductLicence(List<int> productIds, string companyName)

Parameters

Nome Tipo Descrição
productIds List<int>
companyName string

Returns

bool

IsConcurrentConsumptionProduct(int) 

public static bool IsConcurrentConsumptionProduct(int product)

Parameters

Nome Tipo Descrição
product int

Returns

bool

IsLimitedConsumptionProduct(int) 

public static bool IsLimitedConsumptionProduct(int product)

Parameters

Nome Tipo Descrição
product int

Returns

bool

IsNumberLoginAvailable() 

public static bool IsNumberLoginAvailable()

Returns

bool

IsProductLicence(int) 

public static bool IsProductLicence(int productId)

Parameters

Nome Tipo Descrição
productId int

Returns

bool

IsProductLicence(int, string)

Use this form of validation only in very specific cases, always opt for the signature without indicating the name of the database

public static bool IsProductLicence(int productId, string companyName)

Parameters

Nome Tipo Descrição
productId int
companyName string

Returns

bool

IsUserCredentialsValid() 

public static bool IsUserCredentialsValid()

Returns

bool

IsUserLoggedIdle() 

public static bool IsUserLoggedIdle()

Returns

bool

IsUserLoggedIn() 

public static bool IsUserLoggedIn()

Returns

bool

ResetLicence() 

public static void ResetLicence()

SetLicence(string) 

public static void SetLicence(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

UserHasAnyConcurrentConsumptionProduct() 

public static bool UserHasAnyConcurrentConsumptionProduct()

Returns

bool

UserHasAnyLimitedConsumptionProduct() 

public static bool UserHasAnyLimitedConsumptionProduct()

Returns

bool

UserHasOnlyLimitedConsumptionProducts() 

public static bool UserHasOnlyLimitedConsumptionProducts()

Returns

bool

addEngineID(string) 

public static void addEngineID(string engineCredentials)

Parameters

Nome Tipo Descrição
engineCredentials string

branding() 

public static Branding branding()

Returns

Branding

delEngineID(string) 

public static void delEngineID(string engineID)

Parameters

Nome Tipo Descrição
engineID string

getConcurrentConsumptionProducts() 

public static List<Products> getConcurrentConsumptionProducts()

Returns

List<Products>

getDBSizeQuota() 

public static int getDBSizeQuota()

Returns

int

getDBSizeQuotaLabel() 

public static string getDBSizeQuotaLabel()

Returns

string

getEngineName(string) 

public static string getEngineName(string engineID)

Parameters

Nome Tipo Descrição
engineID string

Returns

string

getEngineVO(string) 

public static EngineIDLicenceVO getEngineVO(string engineID)

Parameters

Nome Tipo Descrição
engineID string

Returns

EngineIDLicenceVO

getLimitedConsumptionProducts() 

public static List<Products> getLimitedConsumptionProducts()

Returns

List<Products>

invalidLicence(string) 

public static void invalidLicence(string invalidCausedErrorCode)

Parameters

Nome Tipo Descrição
invalidCausedErrorCode string

invalidLicence(string, string[]) 

public static void invalidLicence(string invalidCausedErrorCode, string[] messData)

Parameters

Nome Tipo Descrição
invalidCausedErrorCode string
messData string[]

isEngineIDLicence(string) 

public static bool isEngineIDLicence(string engineID)

Parameters

Nome Tipo Descrição
engineID string

Returns

bool

isGamaAdvancedAvailable() 

public static bool isGamaAdvancedAvailable()

Returns

bool

isGamaAvailable(Gamas) 

public static bool isGamaAvailable(Gamas gamaCheck)

Parameters

Nome Tipo Descrição
gamaCheck Gamas

Returns

bool

isGamaAvailable(int) 

public static bool isGamaAvailable(int gamaCheck)

Parameters

Nome Tipo Descrição
gamaCheck int

Returns

bool

isGamaCorporateAvailable() 

public static bool isGamaCorporateAvailable()

Returns

bool

isGamaEnterpriseAvailable() 

public static bool isGamaEnterpriseAvailable()

Returns

bool

isGamaGrowAvailable() 

public static bool isGamaGrowAvailable()

Returns

bool

isGamaReadyAvailable() 

public static bool isGamaReadyAvailable()

Returns

bool

resetEngineIDs() 

public static void resetEngineIDs()

resetFirstTimeUser() 

public static void resetFirstTimeUser()

setEmpresa(string) 

public static void setEmpresa(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

setEndDate(string) 

public static void setEndDate(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

setFirstTimeUser() 

public static void setFirstTimeUser()

setFirstTimeUserCode(string) 

public static void setFirstTimeUserCode(string usercode)

Parameters

Nome Tipo Descrição
usercode string

setFirstTimeUserEmail(string) 

public static void setFirstTimeUserEmail(string email)

Parameters

Nome Tipo Descrição
email string

setGama(string) 

public static void setGama(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

setSaleLanguage(string) 

public static void setSaleLanguage(string infoLicence)

Parameters

Nome Tipo Descrição
infoLicence string

userHaveAnyProduct(List<int>) 

public static bool userHaveAnyProduct(List<int> products)

Parameters

Nome Tipo Descrição
products List<int>

Returns

bool

userHaveAnyProduct(params int[]) 

public static bool userHaveAnyProduct(params int[] productsId)

Parameters

Nome Tipo Descrição
productsId int[]

Returns

bool

userHaveProduct(int) 

public static bool userHaveProduct(int product)

Parameters

Nome Tipo Descrição
product int

Returns

bool

versao() 

public static string versao()

Returns

string

versaomajor() 

public static string versaomajor()

Returns

string

versaominor() 

public static string versaominor()

Returns

string