Method DetailImageFile createInitials(String initials, String font, boolean italic, boolean bold, int fontSize) Creates an image for initialing purposes.
Parameters:
Returns: ImageFile Since: 07-02-2012 PWA createPWA() Creates a progressive web app and associates it with this user and pal. Returns null if key, enterprise, or profile does not enable PWA. Note- this will immediately send an email to the user notifying of the creation of the PWA. Returns: PWA Since: 10-13-2021 ProfilePacket createPacket() Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console. Returns: ProfilePacket Since: 02-03-2014 ImageFile createSignature(String auditName, String font, boolean italic, boolean bold, int fontSize) Creates an image for signing purposes.
Parameters:
Returns: ImageFile Since: 07-02-2012 deleteConsoleApp(String appId) Deletes the specified console application. Not all applications can be deleted (for example group-based applications).
Parameters:
Since: 09-17-2015 deleteEnterpriseSSO(String ssoId) Deletes the specified enterprise sso.
Parameters:
Since: 09-17-2015 deleteMobileAccess(Pal pal) Deletes mobile access to the Pal. Note- for non personal profiles, this deletes access but discovery is still controlled by group permissions.
Parameters:
Since: 05-04-2011 deletePWA() Deletes the PWA associated with this profile and pal, if any. Since: 10-13-2021 deletePacket(boolean removeConsoleAccess) Deletes the ProfilePacket, if any and removes console access (if personal profile).
Parameters:
Since: 02-03-2014 deleteProductAccess(Pal pal, String productId) Deletes desktop product access to the Pal. Note- for non personal profiles, this deletes access but discovery is still controlled by group permissions.
Parameters:
Since: 10-11-2011 deleteUserSSO(String ssoId) Deletes the specified user sso.
Parameters:
Since: 09-17-2015 enableEnterpriseSSO(String ssoId, boolean enabled) Enables/disables the specified enterprise sso.
Parameters:
Since: 09-17-2015 enableUserSSO(String ssoId, boolean enabled) Enables/disables the specified user sso.
Parameters:
Since: 09-17-2015 String getAccessLevel() Returns the access level this profile has granted to the running Pal. Responses will be 'None', 'ContractPal', 'Enterprise' or 'B2B'. If 'None', advanced information from the profile is not exposed to this Pal. Returns: String Since: 01-15-2010 DataList getAccessLevelOptions() Returns a list of access levels permitted for this profile. Returns: DataList DataList Name: levels DataList Fields: name Since: 06-07-2012 String getAddress() Returns the address of the user associated with this profile. Returns: String Since: 07-06-2009 Data getAddressInformation() Returns address and locale information. Returns: Data Since: 06-07-2012 SSOToken getAuthToken() Returns the sso token, if any, associated with this user and pal. Returns: SSOToken Since: 01-11-2021 String getCellPhone() Returns the cell phone of the user associated with this profile. Returns: String Since: 11-02-2010 String getCellPhoneProvider() Returns the cell phone provider of the user associated with this profile. Returns: String Since: 11-02-2010 String getCity() Returns the city of the user associated with this profile. Returns: String Since: 07-06-2009 String getCountry() Returns the country of the user associated with this profile. Returns: String Since: 07-06-2009 String getCountryCode() Returns the country code of the user associated with this profile. Returns: String Since: 07-06-2009 Data getData() Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise. Returns: Data Since: 01-19-2009 String getDefaultConsoleId() Returns the default console id or null if one is not set. Returns: String Since: 09-17-2015 String getDepartment() Returns department name for this profile Returns: String Since: 11-01-2011 String getDivision() Returns division name for this profile Returns: String Since: 11-01-2011 String getEmailAddress() Returns the email address associated with this profile. Returns: String Since: 03-15-2007 EnterpriseInfo getEnterprise() Returns the enterprise that owns this profile or null if it is a personal profile. Returns: EnterpriseInfo Since: 07-06-2009 SystemDataView getEnterpriseSSOList() Returns enterprise single-sign for this profile. Returns: SystemDataView DataList Name: EnterpriseSSOList
Since: 09-17-2015 String getExitUrl() Returns the best exit URL for this user. Returns: String Since: 11-13-2024 String getFax() Returns the fax of the user associated with this profile. Returns: String Since: 07-06-2009 String getFirstName() Returns the first name of the user associated with this profile. Returns: String Since: 03-15-2007 String getFullName() Returns the combined first and last name of the user associated with this profile. Returns: String Since: 12-02-2009 SystemDataView getGroupConsoleApps() Returns console apps for this enterprise profile that are group based. Returns: SystemDataView DataList Name: GroupConsoleApps
Since: 09-17-2015 Data getGroupPermissions(String group) Returns a Data object (read only) containing the permissions the enterprise profile has for the specified group. See hasGroupPermission for permission names.
Parameters:
Returns: Data Since: 01-11-2010 DataList getGroups() Returns a DataList of all groups this profile is a member of. Returns: DataList DataList Name: groups DataList Fields: name, description Since: 12-18-2008 DataList getGroupsWithPermission(String permission) Returns a DataList of all groups this profile is a member of that have the specified permission. Possible choices are: accessTransaction,accessConsolePal,createTransaction,deleteTransaction,accessTransactionLogs,accessTransactionTechnical,managePals,userWebService,manageArchive,developPals
Parameters:
Returns: DataList DataList Name: groups DataList Fields: name, description Since: 01-25-2010 String getId() Returns unique ID of profile. Returns null if profile is not registered. Returns: String Since: 02-04-2009 String getLanguage() Returns the language of the user associated with this profile. Returns: String Since: 07-06-2009 String getLastName() Returns the last name of the user associated with this profile. Returns: String Since: 03-15-2007 String getMiddleName() Returns the middle name of the user associated with this profile. Returns: String Since: 07-06-2009 String getName() Returns the name of the profile. Returns: String Since: 09-10-2008 PWA getPWA() Returns the progressive web app, if any, associated with this user and pal. Returns: PWA Since: 10-13-2021 ProfilePacket getPacket() Returns the ProfilePacket associated with this User and Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console. Returns: ProfilePacket Since: 02-03-2014 ProfilePalManager getPalManager() Returns the pal manager for this profile. Returns: ProfilePalManager Since: 09-22-2015 Data getPalManagerGroupSettings(String group) Returns Pal manager settings for the specified Group.
Parameters:
Returns: Data Since: 03-02-2012 Data getPalManagerPalSettings(PalInfo palInfo) Returns Pal manager settings for the specified Pal.
Parameters:
Returns: Data Since: 03-02-2012 Data getPermissions() Returns a Data object (read only) containing all permissions of the enterprise profile. Possible choices are: manageUsers,manageStats,manageReseller,enterpriseOwner,manageEnterprise,manageGlobalSettings,manageServices,accounting,manageGroups,manageB2B,manageUnassignedTransactions,manageEnterpriseActivationKeys,manageStore,manageDesktopSoftware,manageSystemActivationKeys,manageZones,managePalChains,manageSSO,manageRemoteProviders,manageResources,systemAccounting,systemStatements,systemSupport,manageEnterprises,systemAdmin,systemDeleteEnterprise,systemStats Returns: Data Since: 01-11-2010 String getPhone() Returns the phone of the user associated with this profile. Returns: String Since: 07-06-2009 String getPostalCode() Returns the postal code of the user associated with this profile. Returns: String Since: 07-06-2009 Data getPreferences() Returns the preferences. Returns: Data Since: 10-23-2015 SystemDataView getProfileConsoleApps() Returns console apps associated with this profile. Returns: SystemDataView DataList Name: ProfileConsoleApps
Since: 09-17-2015 Data getProfileInformation() Returns the base profile information Returns: Data Since: 06-07-2012 String getSalesId() Returns Sales ID for this profile Returns: String Since: 11-01-2011 String getState() Returns the state of the user associated with this profile. Returns: String Since: 07-06-2009 String getStateCode() Returns the state code of the user associated with this profile. Returns: String Since: 07-06-2009 String getTimeZone() Returns the time zone of the user associated with this profile. Returns: String Since: 07-06-2009 String getTimeZoneCode() Returns the time zone code of the user associated with this profile. Returns: String Since: 07-06-2009 String getTitle() Returns the title or job title of the user associated with this profile. Returns: String Since: 07-06-2009 ProfileTxManager getTransactionManager() Returns the transaction manager for this profile. Returns: ProfileTxManager Since: 09-22-2015 Data getTransactionManagerGroupSettings(String group) Returns transaction manager settings for the specified Group.
Parameters:
Returns: Data Since: 03-02-2012 String getUserId() Returns unique ID of the user associated with this profile. Returns null if profile is not registered. Returns: String Since: 06-29-2011 SystemDataView getUserSSOList() Returns user single-sign for this profile. Returns: SystemDataView DataList Name: UserSSOList
Since: 09-17-2015 boolean hasConsoleAccess(String palId) Returns true if this profile can access the specified Console Pal.
Parameters:
Returns: boolean Since: 03-30-2009 boolean hasGroupPermission(String group, String permission) Returns true the enterprise profile has the group permission. Possible choices are: accessTransaction,accessConsolePal,createTransaction,deleteTransaction,accessTransactionLogs,accessTransactionTechnical,managePals,userWebService,manageArchive,developPals
Parameters:
Returns: boolean Since: 01-11-2010 boolean hasMobileAccess(Pal pal) Returns true if the profile has been granted mobile access to the Pal.
Parameters:
Returns: boolean Since: 05-04-2011 boolean hasPermission(String permission) Returns true the enterprise profile has the specified system permission. Possible choices are: manageUsers,manageStats,manageReseller,enterpriseOwner,manageEnterprise,manageGlobalSettings,manageServices,accounting,manageGroups,manageB2B,manageUnassignedTransactions,manageEnterpriseActivationKeys,manageStore,manageDesktopSoftware,manageSystemActivationKeys,manageZones,managePalChains,manageSSO,manageRemoteProviders,manageResources,systemAccounting,systemStatements,systemSupport,manageEnterprises,systemAdmin,systemDeleteEnterprise,systemStats
Parameters:
Returns: boolean Since: 01-11-2010 boolean hasProductAccess(Pal pal, String productId) Returns true if the profile has been granted desktop product access to the Pal.
Parameters:
Returns: boolean Since: 10-11-2011 boolean hasRole(String role, String txId) Returns true if the profile has a role on the specified transaction.
Parameters:
Returns: boolean Since: 06-01-2009 boolean isDefaultProfile() Returns true if this profile is the default profile for the user. Returns: boolean Since: 11-29-2010 boolean isEnterprise() Returns true if this profile is an enterprise profile. Returns: boolean Since: 03-15-2007 boolean isFloatingLicense() Returns true if the licenseType for this profile is floating. Returns: boolean Since: 02-21-2022 boolean isGroupMember(String group) Returns true if this profile is a member of the specified private group.
Parameters:
Returns: boolean Since: 12-18-2008 boolean isOwnedBy(Enterprise enterprise) Returns true if the Enterprise owns this profile.
Parameters:
Returns: boolean Since: 03-02-2011 boolean isOwnedBy(String domain) Returns true if this profile is owned by the enterprise that owns specified domain.
Parameters:
Returns: boolean Since: 03-15-2007 boolean isPersonal() Returns true if this profile is a personal profile. Returns: boolean Since: 03-15-2007 boolean isSupportLicense() Returns true if the licenseType for this profile is support. Returns: boolean Since: 02-21-2022 boolean isSystem() Returns true if this profile is a system profile. Returns: boolean Since: 11-29-2010 boolean isUserLicense() Returns true if the licenseType for this profile is user. Returns: boolean Since: 02-21-2022 boolean removeFromProfile() Removes the user from the profile. Returns false if personal profile or if the profile is the owner of the corresponding enterprise. On success call InternalUser.switchToProfile and Controller.redrawConsole. Returns: boolean Since: 06-07-2012 boolean setAddressInformation(Data data) Sets the address and local information.
Parameters:
Returns: boolean Since: 06-07-2012 setDefaultConsoleApp(String appId, boolean defaultApp) Sets or un-sets the specified console application as default for this profile.
Parameters:
Since: 09-17-2015 boolean setInitials(String auditInitials, ImageFile initialFile) Updates the user's current profile initials.
Parameters:
Returns: boolean Since: 05-30-2012 boolean setMobileAccess(Pal pal, String mobileConfig) Grants or updates mobile access to this pal. The user must have mobile access enabled in security settings. The Pal must be mobile enabled. If the profile is not enterprise, the user must have user workflow access group permission.
Parameters:
Returns: boolean Since: 05-04-2011 setPreferences(Data data) Sets the preferences.
Parameters:
Since: 10-23-2015 boolean setProductAccess(Pal pal, String productId) Grants or updates desktop product access to this pal. The user must have desktop product access enabled in security settings. If the profile is enterprise, the user must have user workflow access group permission. If this method returns false, check c.getError() to determine why.
Parameters:
Returns: boolean Since: 10-11-2011 boolean setProfileInformation(Data data) Sets the base profile information: profile name, first/middle/last name, etc.
Parameters:
Returns: boolean Since: 06-07-2012 boolean setSignature(String auditName, ImageFile signatureFile) Updates the user's current profile signature.
Parameters:
Returns: boolean Since: 05-30-2012 String toString() Returns a description of this object. Returns: String Since: 05-30-2012 VCardFile toVCardFile(String fileName) Exports this profile information to business card file. Profile information access permission rules apply
Parameters:
Returns: VCardFile Since: 12-13-2011 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Dec 03, 2024 10:24 AM |